danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CONTENT_BROWSER_RENDERER_HOST_CLIPBOARD_HOST_IMPL_H_ |
| 6 | #define CONTENT_BROWSER_RENDERER_HOST_CLIPBOARD_HOST_IMPL_H_ |
| 7 | |
| 8 | #include <map> |
| 9 | #include <memory> |
| 10 | #include <string> |
| 11 | #include <vector> |
| 12 | |
Austin Sullivan | fc87089 | 2021-04-29 18:40:11 | [diff] [blame] | 13 | #include "base/callback_forward.h" |
Daniel Cheng | d4c3eab | 2021-08-31 18:39:01 | [diff] [blame] | 14 | #include "base/gtest_prod_util.h" |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 15 | #include "base/memory/weak_ptr.h" |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 16 | #include "base/time/time.h" |
| 17 | #include "build/build_config.h" |
| 18 | #include "content/browser/renderer_host/render_frame_host_impl.h" |
| 19 | #include "content/common/content_export.h" |
Daniel Cheng | 9fb887ff | 2021-10-01 20:27:38 | [diff] [blame] | 20 | #include "content/public/browser/document_service.h" |
Austin Sullivan | fc87089 | 2021-04-29 18:40:11 | [diff] [blame] | 21 | #include "mojo/public/cpp/base/big_buffer.h" |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 22 | #include "mojo/public/cpp/bindings/receiver.h" |
Anton Bikineev | f62d1bf | 2021-05-15 17:56:07 | [diff] [blame] | 23 | #include "third_party/abseil-cpp/absl/types/optional.h" |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 24 | #include "third_party/blink/public/mojom/clipboard/clipboard.mojom.h" |
| 25 | #include "ui/base/clipboard/clipboard.h" |
| 26 | |
| 27 | class GURL; |
| 28 | |
| 29 | namespace ui { |
| 30 | class ScopedClipboardWriter; |
| 31 | } // namespace ui |
| 32 | |
| 33 | namespace content { |
| 34 | |
| 35 | class ClipboardHostImplTest; |
| 36 | |
Alexander Timin | e3383d0 | 2021-06-24 19:57:59 | [diff] [blame] | 37 | class CONTENT_EXPORT ClipboardHostImpl |
Daniel Cheng | 9fb887ff | 2021-10-01 20:27:38 | [diff] [blame] | 38 | : public DocumentService<blink::mojom::ClipboardHost> { |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 39 | public: |
| 40 | ~ClipboardHostImpl() override; |
| 41 | |
| 42 | static void Create( |
| 43 | RenderFrameHost* render_frame_host, |
| 44 | mojo::PendingReceiver<blink::mojom::ClipboardHost> receiver); |
| 45 | |
| 46 | protected: |
| 47 | // These types and methods are protected for testing. |
| 48 | |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 49 | using ClipboardPasteContentAllowed = |
| 50 | RenderFrameHostImpl::ClipboardPasteContentAllowed; |
| 51 | using IsClipboardPasteContentAllowedCallback = |
| 52 | RenderFrameHostImpl::IsClipboardPasteContentAllowedCallback; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 53 | |
| 54 | // Keeps track of a request to see if some clipboard content, identified by |
| 55 | // its sequence number, is allowed to be pasted into the render frame host |
| 56 | // that owns this clipboard host. |
| 57 | // |
| 58 | // A request starts in the state incomplete until Complete() is called with |
| 59 | // a value. Callbacks can be added to the request before or after it has |
| 60 | // completed. |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 61 | class CONTENT_EXPORT IsPasteContentAllowedRequest { |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 62 | public: |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 63 | IsPasteContentAllowedRequest(); |
| 64 | ~IsPasteContentAllowedRequest(); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 65 | |
| 66 | // Adds |callback| to be notified when the request completes. If the |
| 67 | // request is already completed |callback| is invoked immediately. Returns |
| 68 | // true if a request should be started after adding this callback. |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 69 | bool AddCallback(IsClipboardPasteContentAllowedCallback callback); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 70 | |
| 71 | // Mark this request as completed with the specified result. |
| 72 | // Invoke all callbacks now. |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 73 | void Complete(ClipboardPasteContentAllowed allowed); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 74 | |
| 75 | // Returns true if this request is obsolete. An obsolete request |
| 76 | // is one that is completed, all registered callbacks have been |
| 77 | // called, and is considered old. |
| 78 | // |
| 79 | // |now| represents the current time. It is an argument to ease testing. |
| 80 | bool IsObsolete(base::Time now); |
| 81 | |
| 82 | // Returns the time at which this request was created. |
| 83 | base::Time time() { return time_; } |
| 84 | |
| 85 | private: |
| 86 | // Calls all the callbacks in |callbacks_| with the current value of |
| 87 | // |allowed_|. |allowed_| must not be empty. |
| 88 | void InvokeCallbacks(); |
| 89 | |
| 90 | base::Time time_{base::Time::Now()}; |
Anton Bikineev | f62d1bf | 2021-05-15 17:56:07 | [diff] [blame] | 91 | absl::optional<ClipboardPasteContentAllowed> allowed_; |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 92 | std::vector<IsClipboardPasteContentAllowedCallback> callbacks_; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 93 | }; |
| 94 | |
| 95 | // A paste allowed request is obsolete if it is older than this time. |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 96 | static const base::TimeDelta kIsPasteContentAllowedRequestTooOld; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 97 | |
Alexander Timin | e3383d0 | 2021-06-24 19:57:59 | [diff] [blame] | 98 | explicit ClipboardHostImpl( |
| 99 | RenderFrameHost* render_frame_host, |
| 100 | mojo::PendingReceiver<blink::mojom::ClipboardHost> receiver); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 101 | |
Aya ElAttar | 84e6ef3 | 2021-03-02 16:29:19 | [diff] [blame] | 102 | // Performs a check to see if pasting `data` is allowed by data transfer |
| 103 | // policies and invokes PasteIfPolicyAllowedCallback upon completion. |
| 104 | // PerformPasteIfContentAllowed maybe be invoked immediately if the policy |
| 105 | // controller doesn't exist. |
| 106 | void PasteIfPolicyAllowed(ui::ClipboardBuffer clipboard_buffer, |
| 107 | const ui::ClipboardFormatType& data_type, |
| 108 | std::string data, |
| 109 | IsClipboardPasteContentAllowedCallback callback); |
| 110 | |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 111 | // Performs a check to see if pasting |data| is allowed and invokes |callback| |
Aya ElAttar | 84e6ef3 | 2021-03-02 16:29:19 | [diff] [blame] | 112 | // upon completion. |callback| may be invoked immediately if the data has |
| 113 | // already been checked. |data| and |seqno| should corresponds to the same |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 114 | // clipboard data. |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 115 | void PerformPasteIfContentAllowed( |
Austin Sullivan | bfe1af7 | 2021-07-20 23:14:14 | [diff] [blame] | 116 | const ui::ClipboardSequenceNumberToken& seqno, |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 117 | const ui::ClipboardFormatType& data_type, |
| 118 | std::string data, |
| 119 | IsClipboardPasteContentAllowedCallback callback); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 120 | |
| 121 | // Remove obsolete entries from the outstanding requests map. |
| 122 | // A request is obsolete if: |
| 123 | // - its sequence number is less than |seqno| |
| 124 | // - it has no callbacks |
| 125 | // - it is too old |
| 126 | void CleanupObsoleteRequests(); |
| 127 | |
Aya ElAttar | 84e6ef3 | 2021-03-02 16:29:19 | [diff] [blame] | 128 | // Completion callback of PerformPasteIfContentAllowed(). Sets the allowed |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 129 | // status for the clipboard data corresponding to sequence number |seqno|. |
Austin Sullivan | bfe1af7 | 2021-07-20 23:14:14 | [diff] [blame] | 130 | void FinishPasteIfContentAllowed( |
| 131 | const ui::ClipboardSequenceNumberToken& seqno, |
| 132 | ClipboardPasteContentAllowed allowed); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 133 | |
Austin Sullivan | bfe1af7 | 2021-07-20 23:14:14 | [diff] [blame] | 134 | const std::map<ui::ClipboardSequenceNumberToken, |
| 135 | IsPasteContentAllowedRequest>& |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 136 | is_paste_allowed_requests_for_testing() { |
| 137 | return is_allowed_requests_; |
| 138 | } |
| 139 | |
| 140 | private: |
| 141 | friend class ClipboardHostImplTest; |
| 142 | friend class ClipboardHostImplScanTest; |
| 143 | FRIEND_TEST_ALL_PREFIXES(ClipboardHostImplTest, |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 144 | IsPasteContentAllowedRequest_AddCallback); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 145 | FRIEND_TEST_ALL_PREFIXES(ClipboardHostImplTest, |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 146 | IsPasteContentAllowedRequest_Complete); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 147 | FRIEND_TEST_ALL_PREFIXES(ClipboardHostImplTest, |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 148 | IsPasteContentAllowedRequest_IsObsolete); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 149 | FRIEND_TEST_ALL_PREFIXES(ClipboardHostImplScanTest, |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 150 | PerformPasteIfContentAllowed_EmptyData); |
| 151 | FRIEND_TEST_ALL_PREFIXES(ClipboardHostImplScanTest, |
| 152 | PerformPasteIfContentAllowed); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 153 | |
| 154 | // mojom::ClipboardHost |
| 155 | void GetSequenceNumber(ui::ClipboardBuffer clipboard_buffer, |
| 156 | GetSequenceNumberCallback callback) override; |
| 157 | void IsFormatAvailable(blink::mojom::ClipboardFormat format, |
| 158 | ui::ClipboardBuffer clipboard_buffer, |
| 159 | IsFormatAvailableCallback callback) override; |
| 160 | void ReadAvailableTypes(ui::ClipboardBuffer clipboard_buffer, |
| 161 | ReadAvailableTypesCallback callback) override; |
| 162 | void ReadText(ui::ClipboardBuffer clipboard_buffer, |
| 163 | ReadTextCallback callback) override; |
| 164 | void ReadHtml(ui::ClipboardBuffer clipboard_buffer, |
| 165 | ReadHtmlCallback callback) override; |
| 166 | void ReadSvg(ui::ClipboardBuffer clipboard_buffer, |
| 167 | ReadSvgCallback callback) override; |
| 168 | void ReadRtf(ui::ClipboardBuffer clipboard_buffer, |
| 169 | ReadRtfCallback callback) override; |
Austin Sullivan | aa06098 | 2021-06-25 17:49:30 | [diff] [blame] | 170 | void ReadPng(ui::ClipboardBuffer clipboard_buffer, |
| 171 | ReadPngCallback callback) override; |
Joel Hockey | 4c0cb8c | 2021-02-22 02:59:59 | [diff] [blame] | 172 | void ReadFiles(ui::ClipboardBuffer clipboard_buffer, |
| 173 | ReadFilesCallback callback) override; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 174 | void ReadCustomData(ui::ClipboardBuffer clipboard_buffer, |
Jan Wilken Dörrie | aace0cfef | 2021-03-11 22:01:58 | [diff] [blame] | 175 | const std::u16string& type, |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 176 | ReadCustomDataCallback callback) override; |
Anupam Snigdha | 74b68e4 | 2021-08-10 23:35:59 | [diff] [blame] | 177 | void ReadAvailableCustomAndStandardFormats( |
| 178 | ReadAvailableCustomAndStandardFormatsCallback callback) override; |
| 179 | void ReadUnsanitizedCustomFormat( |
| 180 | const std::u16string& format, |
| 181 | ReadUnsanitizedCustomFormatCallback callback) override; |
| 182 | void WriteUnsanitizedCustomFormat(const std::u16string& format, |
| 183 | mojo_base::BigBuffer data) override; |
Jan Wilken Dörrie | aace0cfef | 2021-03-11 22:01:58 | [diff] [blame] | 184 | void WriteText(const std::u16string& text) override; |
| 185 | void WriteHtml(const std::u16string& markup, const GURL& url) override; |
| 186 | void WriteSvg(const std::u16string& markup) override; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 187 | void WriteSmartPasteMarker() override; |
| 188 | void WriteCustomData( |
Jan Wilken Dörrie | aace0cfef | 2021-03-11 22:01:58 | [diff] [blame] | 189 | const base::flat_map<std::u16string, std::u16string>& data) override; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 190 | void WriteBookmark(const std::string& url, |
Jan Wilken Dörrie | aace0cfef | 2021-03-11 22:01:58 | [diff] [blame] | 191 | const std::u16string& title) override; |
danakj | bdf1e0a | 2020-11-10 18:27:47 | [diff] [blame] | 192 | void WriteImage(const SkBitmap& unsafe_bitmap) override; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 193 | void CommitWrite() override; |
Xiaohan Wang | 7f8052e0 | 2022-01-14 18:44:28 | [diff] [blame] | 194 | #if BUILDFLAG(IS_MAC) |
Jan Wilken Dörrie | aace0cfef | 2021-03-11 22:01:58 | [diff] [blame] | 195 | void WriteStringToFindPboard(const std::u16string& text) override; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 196 | #endif |
| 197 | |
Anupam Snigdha | 74b68e4 | 2021-08-10 23:35:59 | [diff] [blame] | 198 | // Returns true if custom format is allowed to be read/written from/to the |
| 199 | // clipboard, else, fails. |
| 200 | bool IsUnsanitizedCustomFormatContentAllowed(); |
| 201 | |
Darwin Huang | 6195d04 | 2021-02-12 22:36:00 | [diff] [blame] | 202 | // Called by PerformPasteIfContentAllowed() when an is allowed request is |
| 203 | // needed. Virtual to be overridden in tests. |
| 204 | virtual void StartIsPasteContentAllowedRequest( |
Austin Sullivan | bfe1af7 | 2021-07-20 23:14:14 | [diff] [blame] | 205 | const ui::ClipboardSequenceNumberToken& seqno, |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 206 | const ui::ClipboardFormatType& data_type, |
| 207 | std::string data); |
| 208 | |
Aya ElAttar | 84e6ef3 | 2021-03-02 16:29:19 | [diff] [blame] | 209 | // Completion callback of PasteIfPolicyAllowed. If `is_allowed` is set to |
| 210 | // true, PerformPasteIfContentAllowed will be invoked. Otherwise `callback` |
| 211 | // will be invoked immediately to cancel the paste. |
| 212 | void PasteIfPolicyAllowedCallback( |
| 213 | ui::ClipboardBuffer clipboard_buffer, |
| 214 | const ui::ClipboardFormatType& data_type, |
| 215 | std::string data, |
| 216 | IsClipboardPasteContentAllowedCallback callback, |
| 217 | bool is_allowed); |
| 218 | |
Anthony Vallee-Dubois | ac84770 | 2021-12-06 21:00:48 | [diff] [blame] | 219 | using CopyAllowedCallback = base::OnceCallback<void()>; |
| 220 | void CopyIfAllowed(size_t data_size_in_bytes, CopyAllowedCallback callback); |
| 221 | |
Austin Sullivan | fc87089 | 2021-04-29 18:40:11 | [diff] [blame] | 222 | void OnReadPng(ui::ClipboardBuffer clipboard_buffer, |
| 223 | ReadPngCallback callback, |
| 224 | const std::vector<uint8_t>& data); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 225 | |
Aya ElAttar | 5e8cfb08 | 2020-10-28 14:33:18 | [diff] [blame] | 226 | std::unique_ptr<ui::DataTransferEndpoint> CreateDataEndpoint(); |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 227 | |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 228 | std::unique_ptr<ui::ScopedClipboardWriter> clipboard_writer_; |
| 229 | |
| 230 | // Outstanding is allowed requests per clipboard contents. Maps a clipboard |
| 231 | // sequence number to an outstanding request. |
Austin Sullivan | bfe1af7 | 2021-07-20 23:14:14 | [diff] [blame] | 232 | std::map<ui::ClipboardSequenceNumberToken, IsPasteContentAllowedRequest> |
| 233 | is_allowed_requests_; |
danakj | c492bf8 | 2020-09-09 20:02:44 | [diff] [blame] | 234 | |
| 235 | base::WeakPtrFactory<ClipboardHostImpl> weak_ptr_factory_{this}; |
| 236 | }; |
| 237 | |
| 238 | } // namespace content |
| 239 | |
| 240 | #endif // CONTENT_BROWSER_RENDERER_HOST_CLIPBOARD_HOST_IMPL_H_ |