1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
// Many of these functions are based on those found in
// webkit/port/platform/PasteboardWin.cpp
#include "ui/base/clipboard/clipboard_win.h"
#include <objidl.h>
#include <shellapi.h>
#include <shlobj.h>
#include <cstdint>
#include <string_view>
#include <vector>
#include "base/check_op.h"
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/lazy_instance.h"
#include "base/notreached.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/sys_string_conversions.h"
#include "base/strings/utf_offset_string_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/current_thread.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "base/win/message_window.h"
#include "base/win/scoped_gdi_object.h"
#include "base/win/scoped_hdc.h"
#include "base/win/scoped_hglobal.h"
#include "clipboard_util.h"
#include "net/base/filename_util.h"
#include "skia/ext/skia_utils_base.h"
#include "skia/ext/skia_utils_win.h"
#include "third_party/skia/include/core/SkBitmap.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/clipboard_util_win.h"
#include "ui/base/clipboard/custom_data_helper.h"
#include "ui/base/data_transfer_policy/data_transfer_endpoint.h"
#include "ui/base/ui_base_features.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/codec/png_codec.h"
#include "ui/gfx/geometry/size.h"
#include "url/gurl.h"
namespace ui {
namespace {
// A scoper to impersonate the anonymous token and revert when leaving scope
class AnonymousImpersonator {
public:
AnonymousImpersonator() {
must_revert_ = ::ImpersonateAnonymousToken(::GetCurrentThread());
}
AnonymousImpersonator(const AnonymousImpersonator&) = delete;
AnonymousImpersonator& operator=(const AnonymousImpersonator&) = delete;
~AnonymousImpersonator() {
if (must_revert_)
::RevertToSelf();
}
private:
BOOL must_revert_;
};
// A scoper to manage acquiring and automatically releasing the clipboard.
class ScopedClipboard {
public:
ScopedClipboard() : opened_(false) { }
~ScopedClipboard() {
if (opened_)
Release();
}
bool Acquire(HWND owner) {
const int kMaxAttemptsToOpenClipboard = 5;
CHECK(!opened_);
// Attempt to open the clipboard, which will acquire the Windows clipboard
// lock. This may fail if another process currently holds this lock.
// We're willing to try a few times in the hopes of acquiring it.
//
// This turns out to be an issue when using remote desktop because the
// rdpclip.exe process likes to read what we've written to the clipboard and
// send it to the RDP client. If we open and close the clipboard in quick
// succession, we might be trying to open it while rdpclip.exe has it open,
// See Bug 815425.
//
// In fact, we believe we'll only spin this loop over remote desktop. In
// normal situations, the user is initiating clipboard operations and there
// shouldn't be contention.
for (int attempts = 0; attempts < kMaxAttemptsToOpenClipboard; ++attempts) {
if (::OpenClipboard(owner)) {
opened_ = true;
return true;
}
// If we didn't manage to open the clipboard, sleep a bit and be hopeful.
::Sleep(5);
}
// We failed to acquire the clipboard.
return false;
}
void Release() {
CHECK(opened_);
// Impersonate the anonymous token during the call to CloseClipboard
// This prevents Windows 8+ capturing the broker's access token which
// could be accessed by lower-privileges chrome processes leading to
// a risk of EoP
AnonymousImpersonator impersonator;
::CloseClipboard();
opened_ = false;
}
private:
bool opened_;
};
bool ClipboardOwnerWndProc(UINT message,
WPARAM wparam,
LPARAM lparam,
LRESULT* result) {
switch (message) {
case WM_RENDERFORMAT:
// This message comes when SetClipboardData was sent a null data handle
// and now it's come time to put the data on the clipboard.
// We always set data, so there isn't a need to actually do anything here.
break;
case WM_RENDERALLFORMATS:
// This message comes when SetClipboardData was sent a null data handle
// and now this application is about to quit, so it must put data on
// the clipboard before it exits.
// We always set data, so there isn't a need to actually do anything here.
break;
case WM_DRAWCLIPBOARD:
break;
case WM_DESTROY:
break;
case WM_CHANGECBCHAIN:
break;
case WM_CLIPBOARDUPDATE:
ClipboardMonitor::GetInstance()->NotifyClipboardDataChanged();
break;
default:
return false;
}
*result = 0;
return true;
}
template <typename charT>
HGLOBAL CreateGlobalData(const std::basic_string<charT>& str) {
HGLOBAL data =
::GlobalAlloc(GMEM_MOVEABLE, ((str.size() + 1) * sizeof(charT)));
if (data) {
charT* raw_data = static_cast<charT*>(::GlobalLock(data));
memcpy(raw_data, str.data(), str.size() * sizeof(charT));
raw_data[str.size()] = '\0';
::GlobalUnlock(data);
}
return data;
}
bool BitmapHasInvalidPremultipliedColors(const SkPixmap& pixmap) {
for (int x = 0; x < pixmap.width(); ++x) {
for (int y = 0; y < pixmap.height(); ++y) {
uint32_t pixel = *pixmap.addr32(x, y);
if (SkColorGetR(pixel) > SkColorGetA(pixel) ||
SkColorGetG(pixel) > SkColorGetA(pixel) ||
SkColorGetB(pixel) > SkColorGetA(pixel))
return true;
}
}
return false;
}
void MakeBitmapOpaque(SkPixmap* pixmap) {
for (int x = 0; x < pixmap->width(); ++x) {
for (int y = 0; y < pixmap->height(); ++y) {
*pixmap->writable_addr32(x, y) =
SkColorSetA(*pixmap->addr32(x, y), SK_AlphaOPAQUE);
}
}
}
template <typename StringType>
void TrimAfterNull(StringType* result) {
// Text copied to the clipboard may explicitly contain null characters that
// should be ignored, depending on the application that does the copying.
constexpr typename StringType::value_type kNull = 0;
size_t pos = result->find_first_of(kNull);
if (pos != StringType::npos)
result->resize(pos);
}
bool ReadFilenamesAvailable() {
return ::IsClipboardFormatAvailable(
ClipboardFormatType::CFHDropType().ToFormatEtc().cfFormat) ||
::IsClipboardFormatAvailable(
ClipboardFormatType::FilenameType().ToFormatEtc().cfFormat) ||
::IsClipboardFormatAvailable(
ClipboardFormatType::FilenameAType().ToFormatEtc().cfFormat);
}
} // namespace
// Clipboard factory method.
// static
Clipboard* Clipboard::Create() {
return new ClipboardWin;
}
// ClipboardWin implementation.
ClipboardWin::ClipboardWin() {
if (base::CurrentUIThread::IsSet())
clipboard_owner_ = std::make_unique<base::win::MessageWindow>();
if (base::FeatureList::IsEnabled(features::kClipboardChangeEvent)) {
ui::ClipboardMonitor::GetInstance()->SetNotifier(this);
}
}
ClipboardWin::~ClipboardWin() {
if (ui::ClipboardMonitor::GetInstance()->GetNotifier() == this) {
ui::ClipboardMonitor::GetInstance()->SetNotifier(nullptr);
}
if (monitoring_clipboard_changes_) {
StopNotifying();
}
}
void ClipboardWin::OnPreShutdown() {}
std::optional<DataTransferEndpoint> ClipboardWin::GetSource(
ClipboardBuffer buffer) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow())) {
return std::nullopt;
}
HANDLE data = ::GetClipboardData(
ClipboardFormatType::InternalSourceUrlType().ToFormatEtc().cfFormat);
if (!data) {
return std::nullopt;
}
std::string source_string;
source_string.assign(static_cast<const char*>(::GlobalLock(data)),
::GlobalSize(data));
::GlobalUnlock(data);
TrimAfterNull(&source_string);
GURL source_url(source_string);
if (!source_url.is_valid()) {
return std::nullopt;
}
return DataTransferEndpoint(std::move(source_url));
}
const ClipboardSequenceNumberToken& ClipboardWin::GetSequenceNumber(
ClipboardBuffer buffer) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
DWORD sequence_number = ::GetClipboardSequenceNumber();
if (sequence_number != clipboard_sequence_.sequence_number) {
// Generate a unique token associated with the current sequence number.
clipboard_sequence_ = {sequence_number, ClipboardSequenceNumberToken()};
}
return clipboard_sequence_.token;
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
bool ClipboardWin::IsFormatAvailable(
const ClipboardFormatType& format,
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
if (format == ClipboardFormatType::FilenameType())
return ReadFilenamesAvailable();
// Chrome can retrieve an image from the clipboard as either a bitmap or PNG.
if (format == ClipboardFormatType::PngType() ||
format == ClipboardFormatType::BitmapType()) {
return ::IsClipboardFormatAvailable(
ClipboardFormatType::PngType().ToFormatEtc().cfFormat) !=
FALSE ||
::IsClipboardFormatAvailable(
ClipboardFormatType::BitmapType().ToFormatEtc().cfFormat) !=
FALSE;
}
return ::IsClipboardFormatAvailable(format.ToFormatEtc().cfFormat) != FALSE;
}
void ClipboardWin::Clear(ClipboardBuffer buffer) {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
{
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow())) {
return;
}
::EmptyClipboard();
}
// When monitoring clipboard from OS, upon clipboard change, the platform
// sends WM_CLIPBOARDUPDATE message during which we already notify
// the ClipboardMonitor of the clipboard data change.
if (!monitoring_clipboard_changes_) {
// This call must happen after `clipboard`'s destructor so that observers
// are notified after the seqno has changed.
ClipboardMonitor::GetInstance()->NotifyClipboardDataChanged();
}
}
std::vector<std::u16string> ClipboardWin::GetStandardFormats(
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst) const {
std::vector<std::u16string> types;
if (::IsClipboardFormatAvailable(
ClipboardFormatType::PlainTextAType().ToFormatEtc().cfFormat)) {
types.push_back(kMimeTypePlainText16);
}
if (::IsClipboardFormatAvailable(
ClipboardFormatType::HtmlType().ToFormatEtc().cfFormat)) {
types.push_back(kMimeTypeHtml16);
}
if (::IsClipboardFormatAvailable(
ClipboardFormatType::SvgType().ToFormatEtc().cfFormat)) {
types.push_back(kMimeTypeSvg16);
}
if (::IsClipboardFormatAvailable(
ClipboardFormatType::RtfType().ToFormatEtc().cfFormat)) {
types.push_back(kMimeTypeRtf16);
}
if (::IsClipboardFormatAvailable(CF_DIB)) {
types.push_back(kMimeTypePng16);
}
if (ReadFilenamesAvailable()) {
types.push_back(kMimeTypeUriList16);
}
return types;
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadAvailableTypes(
ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::vector<std::u16string>* types) const {
DCHECK(types);
types->clear();
*types = GetStandardFormats(buffer, data_dst);
// Read the custom type only if it's present on the clipboard.
// See crbug.com/1477344 for details.
if (!IsFormatAvailable(ClipboardFormatType::DataTransferCustomType(), buffer,
data_dst)) {
return;
}
// Acquire the clipboard to read DataTransferCustomType types.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE hdata = ::GetClipboardData(
ClipboardFormatType::DataTransferCustomType().ToFormatEtc().cfFormat);
if (!hdata)
return;
base::win::ScopedHGlobal<const uint8_t*> locked_data(hdata);
ReadCustomDataTypes(locked_data, types);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadText(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kText);
CHECK(result);
result->clear();
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE data = ::GetClipboardData(CF_UNICODETEXT);
if (!data)
return;
result->assign(static_cast<const char16_t*>(::GlobalLock(data)),
::GlobalSize(data) / sizeof(char16_t));
::GlobalUnlock(data);
TrimAfterNull(result);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadAsciiText(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::string* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kText);
CHECK(result);
result->clear();
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE data = ::GetClipboardData(CF_TEXT);
if (!data)
return;
result->assign(static_cast<const char*>(::GlobalLock(data)),
::GlobalSize(data));
::GlobalUnlock(data);
TrimAfterNull(result);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadHTML(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* markup,
std::string* src_url,
uint32_t* fragment_start,
uint32_t* fragment_end) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kHtml);
markup->clear();
// TODO(dcheng): Remove these checks, I don't think they should be optional.
DCHECK(src_url);
if (src_url)
src_url->clear();
*fragment_start = 0;
*fragment_end = 0;
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE data = ::GetClipboardData(
ClipboardFormatType::HtmlType().ToFormatEtc().cfFormat);
if (!data)
return;
std::string cf_html(static_cast<const char*>(::GlobalLock(data)),
::GlobalSize(data));
::GlobalUnlock(data);
TrimAfterNull(&cf_html);
size_t html_start = std::string::npos;
size_t start_index = std::string::npos;
size_t end_index = std::string::npos;
clipboard_util::CFHtmlExtractMetadata(cf_html, src_url, &html_start,
&start_index, &end_index);
// This might happen if the contents of the clipboard changed and CF_HTML is
// no longer available.
if (start_index == std::string::npos ||
end_index == std::string::npos ||
html_start == std::string::npos)
return;
if (start_index < html_start || end_index < start_index)
return;
std::vector<size_t> offsets = {start_index - html_start,
end_index - html_start};
markup->assign(base::UTF8ToUTF16AndAdjustOffsets(cf_html.data() + html_start,
&offsets));
// Ensure the Fragment points within the string; see https://crbug.com/607181.
size_t end = std::min(offsets[1], markup->length());
*fragment_start = base::checked_cast<uint32_t>(std::min(offsets[0], end));
*fragment_end = base::checked_cast<uint32_t>(end);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadSvg(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kSvg);
std::string data;
ReadData(ClipboardFormatType::SvgType(), data_dst, &data);
if (base::FeatureList::IsEnabled(features::kUseUtf8EncodingForSvgImage)) {
*result = base::UTF8ToUTF16(data);
} else {
result->assign(reinterpret_cast<const char16_t*>(data.data()),
data.size() / sizeof(char16_t));
}
TrimAfterNull(result);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadRTF(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::string* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kRtf);
ReadData(ClipboardFormatType::RtfType(), data_dst, result);
TrimAfterNull(result);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadPng(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
ReadPngCallback callback) const {
RecordRead(ClipboardFormatMetric::kPng);
std::vector<uint8_t> data = ReadPngInternal(buffer);
// On Windows, PNG and bitmap are separate formats. Read PNG if possible,
// otherwise fall back to reading as a bitmap.
if (!data.empty()) {
std::move(callback).Run(data);
return;
}
SkBitmap bitmap = ReadBitmapInternal(buffer);
base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::MayBlock(), base::TaskPriority::USER_BLOCKING},
base::BindOnce(&clipboard_util::EncodeBitmapToPng, bitmap),
std::move(callback));
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadDataTransferCustomData(
ClipboardBuffer buffer,
const std::u16string& type,
const DataTransferEndpoint* data_dst,
std::u16string* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
RecordRead(ClipboardFormatMetric::kCustomData);
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE hdata = ::GetClipboardData(
ClipboardFormatType::DataTransferCustomType().ToFormatEtc().cfFormat);
if (!hdata)
return;
base::win::ScopedHGlobal<const uint8_t*> locked_data(hdata);
if (std::optional<std::u16string> maybe_result =
ReadCustomDataForType(locked_data, type);
maybe_result) {
*result = std::move(*maybe_result);
}
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadFilenames(ClipboardBuffer buffer,
const DataTransferEndpoint* data_dst,
std::vector<ui::FileInfo>* result) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
DCHECK(result);
RecordRead(ClipboardFormatMetric::kFilenames);
result->clear();
if (!ReadFilenamesAvailable())
return;
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
// TODO(crbug.com/40749279): Refactor similar code in clipboard_utils_win:
// clipboard_util::GetFilenames() and reuse rather than duplicate.
HANDLE data = ::GetClipboardData(
ClipboardFormatType::CFHDropType().ToFormatEtc().cfFormat);
if (data) {
{
base::win::ScopedHGlobal<HDROP> hdrop(data);
if (!hdrop.data()) {
return;
}
const int kMaxFilenameLen = 4096;
const unsigned num_files = DragQueryFileW(hdrop.data(), 0xffffffff, 0, 0);
for (unsigned int i = 0; i < num_files; ++i) {
wchar_t filename[kMaxFilenameLen];
if (!DragQueryFileW(hdrop.data(), i, filename, kMaxFilenameLen)) {
continue;
}
base::FilePath path(filename);
result->push_back(ui::FileInfo(path, base::FilePath()));
}
}
return;
}
data = ::GetClipboardData(
ClipboardFormatType::FilenameType().ToFormatEtc().cfFormat);
if (data) {
{
// filename using Unicode
base::win::ScopedHGlobal<wchar_t*> filename(data);
if (filename.data() && filename.data()[0]) {
base::FilePath path(filename.data());
result->push_back(ui::FileInfo(path, base::FilePath()));
}
}
return;
}
data = ::GetClipboardData(
ClipboardFormatType::FilenameAType().ToFormatEtc().cfFormat);
if (data) {
{
// filename using ASCII
base::win::ScopedHGlobal<char*> filename(data);
if (filename.data() && filename.data()[0]) {
base::FilePath path(base::SysNativeMBToWide(filename.data()));
result->push_back(ui::FileInfo(path, base::FilePath()));
}
}
}
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadBookmark(const DataTransferEndpoint* data_dst,
std::u16string* title,
std::string* url) const {
RecordRead(ClipboardFormatMetric::kBookmark);
if (title)
title->clear();
if (url)
url->clear();
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE data =
::GetClipboardData(ClipboardFormatType::UrlType().ToFormatEtc().cfFormat);
if (!data)
return;
std::u16string bookmark(static_cast<const char16_t*>(::GlobalLock(data)),
::GlobalSize(data) / sizeof(char16_t));
::GlobalUnlock(data);
TrimAfterNull(&bookmark);
*url = base::UTF16ToUTF8(bookmark);
}
// |data_dst| is not used. It's only passed to be consistent with other
// platforms.
void ClipboardWin::ReadData(const ClipboardFormatType& format,
const DataTransferEndpoint* data_dst,
std::string* result) const {
RecordRead(ClipboardFormatMetric::kData);
CHECK(result);
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return;
HANDLE data = ::GetClipboardData(format.ToFormatEtc().cfFormat);
if (!data)
return;
result->assign(static_cast<const char*>(::GlobalLock(data)),
::GlobalSize(data));
::GlobalUnlock(data);
}
void ClipboardWin::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) {
{
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow())) {
return;
}
::EmptyClipboard();
DispatchPlatformRepresentations(std::move(platform_representations));
for (const auto& object : objects) {
DispatchPortableRepresentation(object.second);
}
for (const auto& raw_object : raw_objects) {
DispatchPortableRepresentation(raw_object);
}
if (data_src && data_src->IsUrlType()) {
HGLOBAL glob = CreateGlobalData(data_src->GetURL()->spec());
WriteToClipboard(ClipboardFormatType::InternalSourceUrlType(), glob);
}
// Write privacy data if there is any.
// On Windows, there is no special format to conceal passwords, but
// don't save it in the history or cloud clipboard for privacy reasons.
if (privacy_types & Clipboard::PrivacyTypes::kNoDisplay) {
WriteConfidentialDataForPassword();
} else {
if (privacy_types & Clipboard::PrivacyTypes::kNoLocalClipboardHistory) {
WriteClipboardHistory();
}
if (privacy_types & Clipboard::PrivacyTypes::kNoCloudClipboard) {
WriteUploadCloudClipboard();
}
}
}
// When monitoring clipboard from OS, upon clipboard change, the platform
// sends WM_CLIPBOARDUPDATE message during which we already notify
// the ClipboardMonitor of the clipboard data change.
if (!monitoring_clipboard_changes_) {
// This call must happen after `clipboard`'s destructor so that observers
// are notified after the seqno has changed.
ClipboardMonitor::GetInstance()->NotifyClipboardDataChanged();
}
}
void ClipboardWin::WriteText(std::string_view text) {
HGLOBAL glob = CreateGlobalData(base::UTF8ToUTF16(text));
WriteToClipboard(ClipboardFormatType::PlainTextType(), glob);
}
void ClipboardWin::WriteHTML(std::string_view markup,
std::optional<std::string_view> source_url) {
// Add Windows specific headers to the HTML payload before writing to the
// clipboard.
std::string html_fragment =
clipboard_util::HtmlToCFHtml(markup, source_url.value_or(""));
HGLOBAL glob = CreateGlobalData(html_fragment);
WriteToClipboard(ClipboardFormatType::HtmlType(), glob);
}
void ClipboardWin::WriteSvg(std::string_view markup) {
HGLOBAL glob;
if (base::FeatureList::IsEnabled(features::kUseUtf8EncodingForSvgImage)) {
glob = CreateGlobalData(std::string(markup));
} else {
glob = CreateGlobalData(base::UTF8ToUTF16(markup));
}
WriteToClipboard(ClipboardFormatType::SvgType(), glob);
}
void ClipboardWin::WriteRTF(std::string_view rtf) {
WriteData(ClipboardFormatType::RtfType(), base::as_byte_span(rtf));
}
void ClipboardWin::WriteFilenames(std::vector<ui::FileInfo> filenames) {
STGMEDIUM storage = clipboard_util::CreateStorageForFileNames(filenames);
if (storage.tymed == TYMED_NULL)
return;
WriteToClipboard(ClipboardFormatType::CFHDropType(), storage.hGlobal);
}
void ClipboardWin::WriteBookmark(std::string_view title, std::string_view url) {
// On Windows, CFSTR_INETURLW is expected to only contain the URL & not the
// title separated by a newline.
// https://docs.microsoft.com/en-us/windows/win32/shell/clipboard#cfstr_ineturl.
HGLOBAL glob = CreateGlobalData(base::UTF8ToUTF16(url));
WriteToClipboard(ClipboardFormatType::UrlType(), glob);
}
void ClipboardWin::WriteWebSmartPaste() {
DCHECK_NE(clipboard_owner_->hwnd(), nullptr);
::SetClipboardData(
ClipboardFormatType::WebKitSmartPasteType().ToFormatEtc().cfFormat,
nullptr);
}
void ClipboardWin::WriteBitmap(const SkBitmap& bitmap) {
CHECK_EQ(bitmap.colorType(), kN32_SkColorType);
// On Windows there are 2 ways of writing a transparent image to the
// clipboard: Using the DIBV5 format with correct header and format or using
// the PNG format. Some programs only support one or the other. In particular,
// Word support for DIBV5 is buggy and PNG format is needed for it. Writing
// order is also important as some programs will use the first compatible
// format that is available on the clipboard, and we want Word to choose the
// PNG format.
//
// Encode the bitmap to a PNG from the UI thread. Ideally this CPU-intensive
// encoding operation would be performed on a background thread, but
// ui::base::Clipboard writes are (unfortunately) synchronous.
// We could consider making writes async, then moving this image encoding to a
// background sequence.
std::vector<uint8_t> png_encoded_bitmap =
clipboard_util::EncodeBitmapToPngAcceptJank(bitmap);
if (!png_encoded_bitmap.empty()) {
HGLOBAL png_hglobal = skia::CreateHGlobalForByteArray(png_encoded_bitmap);
if (png_hglobal)
WriteToClipboard(ClipboardFormatType::PngType(), png_hglobal);
}
HGLOBAL dibv5_hglobal = skia::CreateDIBV5ImageDataFromN32SkBitmap(bitmap);
if (dibv5_hglobal)
WriteToClipboard(ClipboardFormatType::BitmapType(), dibv5_hglobal);
}
void ClipboardWin::WriteData(const ClipboardFormatType& format,
base::span<const uint8_t> data) {
HGLOBAL hdata = ::GlobalAlloc(GMEM_MOVEABLE, data.size());
if (!hdata)
return;
char* hdata_ptr = static_cast<char*>(::GlobalLock(hdata));
memcpy(hdata_ptr, data.data(), data.size());
::GlobalUnlock(hdata);
WriteToClipboard(format, hdata);
}
void ClipboardWin::WriteClipboardHistory() {
// Write a zero value to the clipboard to indicate that the clipboard history
// is not available.
DWORD value = 0;
WriteData(
ClipboardFormatType::ClipboardHistoryType(),
base::span(reinterpret_cast<const uint8_t*>(&value), sizeof(value)));
}
void ClipboardWin::WriteUploadCloudClipboard() {
// Write a zero value to the clipboard to indicate that the cloud clipboard
// is not available.
DWORD value = 0;
WriteData(
ClipboardFormatType::UploadCloudClipboardType(),
base::span(reinterpret_cast<const uint8_t*>(&value), sizeof(value)));
}
void ClipboardWin::WriteConfidentialDataForPassword() {
// Write a zero value to the clipboard to indicate that the clipboard history
// and cloud clipboard are not available.
DWORD value = 0;
WriteData(
ClipboardFormatType::ClipboardHistoryType(),
base::span(reinterpret_cast<const uint8_t*>(&value), sizeof(value)));
WriteData(
ClipboardFormatType::UploadCloudClipboardType(),
base::span(reinterpret_cast<const uint8_t*>(&value), sizeof(value)));
}
std::vector<uint8_t> ClipboardWin::ReadPngInternal(
ClipboardBuffer buffer) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return std::vector<uint8_t>();
HANDLE data =
::GetClipboardData(ClipboardFormatType::PngType().ToFormatEtc().cfFormat);
if (!data)
return std::vector<uint8_t>();
std::string result(static_cast<const char*>(::GlobalLock(data)),
::GlobalSize(data));
::GlobalUnlock(data);
return std::vector<uint8_t>(result.begin(), result.end());
}
SkBitmap ClipboardWin::ReadBitmapInternal(ClipboardBuffer buffer) const {
DCHECK_EQ(buffer, ClipboardBuffer::kCopyPaste);
// Acquire the clipboard.
ScopedClipboard clipboard;
if (!clipboard.Acquire(GetClipboardWindow()))
return SkBitmap();
// We use a DIB rather than a DDB here since ::GetObject() with the
// HBITMAP returned from ::GetClipboardData(CF_BITMAP) always reports a color
// depth of 32bpp.
BITMAPINFO* bitmap = static_cast<BITMAPINFO*>(::GetClipboardData(CF_DIB));
if (!bitmap)
return SkBitmap();
int color_table_length = 0;
// Image is too large, and may cause an allocation failure.
// See https://crbug.com/1164680.
constexpr size_t kMaxImageSizeBytes = 1 << 27; // 128 MiB
size_t image_size_bytes;
// Estimate the number of bytes per pixel. For images with fewer than one byte
// pixel we will over-estimate the size. For compressed images we will
// over-estimate the size, but some overestimating of the storage size is okay
// and the calculation will be a good estimate of the decompressed size. The
// reported bug was for uncompressed 32-bit images where this code will give
// correct results.
size_t bytes_per_pixel = bitmap->bmiHeader.biBitCount / 8;
if (bytes_per_pixel == 0)
bytes_per_pixel = 1;
// Calculate the size of the bitmap. This is not an exact calculation but that
// doesn't matter for this purpose. If the calculation overflows then the
// image is too big. Return an empty image.
if (!base::CheckMul(
bitmap->bmiHeader.biWidth,
base::CheckMul(bitmap->bmiHeader.biHeight, bytes_per_pixel))
.AssignIfValid(&image_size_bytes))
return SkBitmap();
// If the image size is too big then return an empty image.
if (image_size_bytes > kMaxImageSizeBytes)
return SkBitmap();
// For more information on BITMAPINFOHEADER and biBitCount definition,
// see https://docs.microsoft.com/en-us/windows/win32/wmdm/-bitmapinfoheader
switch (bitmap->bmiHeader.biBitCount) {
case 1:
case 4:
case 8:
color_table_length = bitmap->bmiHeader.biClrUsed
? bitmap->bmiHeader.biClrUsed
: 1 << bitmap->bmiHeader.biBitCount;
break;
case 16:
case 32:
if (bitmap->bmiHeader.biCompression == BI_BITFIELDS)
color_table_length = 3;
break;
case 24:
break;
default:
NOTREACHED();
}
const void* bitmap_bits = reinterpret_cast<const char*>(bitmap) +
bitmap->bmiHeader.biSize +
color_table_length * sizeof(RGBQUAD);
void* dst_bits;
// dst_hbitmap is freed by the release_proc in skia_bitmap (below)
base::win::ScopedGDIObject<HBITMAP> dst_hbitmap = skia::CreateHBitmapXRGB8888(
bitmap->bmiHeader.biWidth, bitmap->bmiHeader.biHeight, 0, &dst_bits);
{
base::win::ScopedCreateDC hdc(CreateCompatibleDC(nullptr));
HBITMAP old_hbitmap =
static_cast<HBITMAP>(SelectObject(hdc.Get(), dst_hbitmap.get()));
::SetDIBitsToDevice(hdc.Get(), 0, 0, bitmap->bmiHeader.biWidth,
bitmap->bmiHeader.biHeight, 0, 0, 0,
bitmap->bmiHeader.biHeight, bitmap_bits, bitmap,
DIB_RGB_COLORS);
SelectObject(hdc.Get(), old_hbitmap);
}
// Windows doesn't really handle alpha channels well in many situations. When
// the source image is < 32 bpp, we force the bitmap to be opaque. When the
// source image is 32 bpp, the alpha channel might still contain garbage data.
// Since Windows uses premultiplied alpha, we scan for instances where
// (R, G, B) > A. If there are any invalid premultiplied colors in the image,
// we assume the alpha channel contains garbage and force the bitmap to be
// opaque as well. This heuristic will fail on a transparent bitmap
// containing only black pixels...
SkPixmap device_pixels(SkImageInfo::MakeN32Premul(bitmap->bmiHeader.biWidth,
bitmap->bmiHeader.biHeight),
dst_bits, bitmap->bmiHeader.biWidth * 4);
{
bool has_invalid_alpha_channel =
bitmap->bmiHeader.biBitCount < 32 ||
BitmapHasInvalidPremultipliedColors(device_pixels);
if (has_invalid_alpha_channel) {
MakeBitmapOpaque(&device_pixels);
}
}
SkBitmap skia_bitmap;
skia_bitmap.installPixels(
device_pixels.info(), device_pixels.writable_addr(),
device_pixels.rowBytes(),
[](void* pixels, void* hbitmap) {
DeleteObject(static_cast<HBITMAP>(hbitmap));
},
dst_hbitmap.release());
return skia_bitmap;
}
void ClipboardWin::WriteToClipboard(ClipboardFormatType format, HANDLE handle) {
UINT cf_format = format.ToFormatEtc().cfFormat;
DCHECK_NE(clipboard_owner_->hwnd(), nullptr);
if (handle && !::SetClipboardData(cf_format, handle)) {
DCHECK_NE(GetLastError(),
static_cast<unsigned long>(ERROR_CLIPBOARD_NOT_OPEN));
::GlobalFree(handle);
}
}
void ClipboardWin::StartNotifying() {
::AddClipboardFormatListener(GetClipboardWindow());
monitoring_clipboard_changes_ = true;
}
void ClipboardWin::StopNotifying() {
::RemoveClipboardFormatListener(GetClipboardWindow());
monitoring_clipboard_changes_ = false;
}
HWND ClipboardWin::GetClipboardWindow() const {
if (!clipboard_owner_)
return nullptr;
if (clipboard_owner_->hwnd() == nullptr)
clipboard_owner_->Create(base::BindRepeating(&ClipboardOwnerWndProc));
return clipboard_owner_->hwnd();
}
} // namespace ui
|