File: screenshot_data_collector.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (348 lines) | stat: -rw-r--r-- 13,679 bytes parent folder | download | duplicates (3)
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
// Copyright 2023 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

#include "chrome/browser/support_tool/screenshot_data_collector.h"

#include <vector>

#include "base/base64.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/strings/strcat.h"
#include "base/strings/stringprintf.h"
#include "base/task/bind_post_task.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "build/chromeos_buildflags.h"
#include "chrome/browser/media/webrtc/capture_policy_utils.h"
#include "chrome/browser/media/webrtc/desktop_media_list.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_finder.h"
#include "chrome/browser/ui/browser_window.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/render_widget_host_view.h"
#include "net/base/data_url.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/codec/jpeg_codec.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/snapshot/snapshot.h"

#if BUILDFLAG(IS_CHROMEOS)
#include "ui/aura/window.h"
#endif  // !BUILDFLAG(IS_CHROMEOS)

namespace {

constexpr char kOriginURL[] = "chrome://support-tool";
constexpr char16_t kName[] = u"Support Tool";
constexpr int kDefaultQuality = 90;
constexpr char kBase64Header[] = "data:image/jpeg;base64,";
constexpr char kCaptureCanceled[] = "CANCELED";

// Encodes `base64_data` and writes the result to `path`. Returns true if
// succeeded and false otherwise.
bool WriteOutputFile(std::string base64_data, base::FilePath path) {
  std::string mime_type, charset, data;
  if (!net::DataURL::Parse(GURL(std::move(base64_data)), &mime_type, &charset,
                           &data) ||
      !base::WriteFile(path, std::move(data))) {
    return false;
  }
  return true;
}

}  // namespace

ScreenshotDataCollector::ScreenshotDataCollector() = default;

ScreenshotDataCollector::~ScreenshotDataCollector() = default;

std::string ScreenshotDataCollector::GetScreenshotBase64() {
  return std::move(screenshot_base64_);
}

void ScreenshotDataCollector::SetScreenshotBase64(
    std::string screenshot_base64) {
  screenshot_base64_ = std::move(screenshot_base64);
}

std::string ScreenshotDataCollector::GetName() const {
  return "Screenshot";
}

std::string ScreenshotDataCollector::GetDescription() const {
  return "Captures a screenshot.";
}

const PIIMap& ScreenshotDataCollector::GetDetectedPII() {
  return pii_map_;
}

void ScreenshotDataCollector::SetPickerFactoryForTesting(
    DesktopMediaPickerFactory* picker_factory_ptr) {
  picker_factory_for_testing_ = picker_factory_ptr;
}

void ScreenshotDataCollector::ConvertDesktopFrameToBase64JPEG(
    std::unique_ptr<webrtc::DesktopFrame> frame,
    std::string& image_base64) {
  // First converts `frame` to SkBitmap.
  SkBitmap bitmap;
  bitmap.allocN32Pixels(frame->size().width(), frame->size().height(), true);
  // Data in `frame` begin at `data()` but are not necessarily consecutive.
  uint32_t* bitmap_buffer = bitmap.getAddr32(0, 0);
  const uint8_t* frame_buffer = frame->data();
  // There are `frame_bytes` bytes of real data per row in `frame`. This is not
  // necessarily the same as `stride()`, which is where the next row of data
  // begins. Also, `frame_bytes` <= `stride()`.
  const size_t frame_bytes =
      frame->size().width() * webrtc::DesktopFrame::kBytesPerPixel;
  // Next we need to copy the data row by row.
  for (int i = 0; i < frame->size().height(); ++i) {
    // Again, `frame_bytes` is the actual size of the data in a row.
    memcpy(bitmap_buffer, frame_buffer, frame_bytes);
    // Moves to where the next row's data begins.
    bitmap_buffer += bitmap.rowBytesAsPixels();
    frame_buffer += frame->stride();
  }
  bitmap.setImmutable();

  // Then encodes the image with jpeg.
  std::optional<std::vector<uint8_t>> jpeg_encoded_data =
      gfx::JPEGCodec::Encode(std::move(bitmap), kDefaultQuality);
  if (!jpeg_encoded_data) {
    SupportToolError error = {SupportToolErrorCode::kDataCollectorError,
                              "ScreenshotDataCollector had error: Failed to "
                              "encode frame to JPEG image."};
    std::move(data_collector_done_callback_).Run(error);
    return;
  }

  // Finally converts the image in a string with base64 encoding.
  image_base64 =
      base::StrCat({kBase64Header,
                    base::Base64Encode(std::move(jpeg_encoded_data.value()))});
}

void ScreenshotDataCollector::CollectDataAndDetectPII(
    DataCollectorDoneCallback on_data_collected_callback,
    scoped_refptr<base::SequencedTaskRunner> task_runner_for_redaction_tool,
    scoped_refptr<redaction::RedactionToolContainer> redaction_tool_container) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  data_collector_done_callback_ = std::move(on_data_collected_callback);
  Browser* browser = chrome::FindBrowserWithActiveWindow();
  if (!browser) {
    browser = chrome::FindLastActive();
  }
  content::WebContents* web_contents =
      browser->tab_strip_model()->GetActiveWebContents();
  gfx::NativeWindow parent_window = web_contents->GetTopLevelNativeWindow();

  // Generates a `DesktopMediaPicker` dialog.
  const GURL origin(kOriginURL);
  const std::u16string name(kName);
  std::vector<DesktopMediaList::Type> media_types = {
      DesktopMediaList::Type::kScreen, DesktopMediaList::Type::kWindow,
      DesktopMediaList::Type::kWebContents};
  AllowedScreenCaptureLevel capture_level =
      capture_policy::GetAllowedCaptureLevel(origin, web_contents);
  capture_policy::FilterMediaList(media_types, capture_level);
  DesktopMediaList::WebContentsFilter includable_web_contents_filter =
      capture_policy::GetIncludableWebContentsFilter(origin, capture_level);

  DesktopMediaPickerController::DoneCallback callback =
      base::BindOnce(&ScreenshotDataCollector::OnSourceSelected,
                     weak_ptr_factory_.GetWeakPtr());
  DesktopMediaPickerController::Params picker_params(
      DesktopMediaPickerController::Params::RequestSource::
          kScreenshotDataCollector);
  picker_params.web_contents = web_contents;
  picker_params.context = parent_window;
  picker_params.parent = parent_window;
  picker_params.app_name = name;
  picker_params.target_name = name;
  picker_params.request_audio = false;
  picker_controller_ = std::make_unique<DesktopMediaPickerController>(
      picker_factory_for_testing_);
  picker_params.restricted_by_policy =
      (capture_level != AllowedScreenCaptureLevel::kUnrestricted);
  picker_controller_->Show(picker_params, std::move(media_types),
                           includable_web_contents_filter, std::move(callback));
}

void ScreenshotDataCollector::OnSourceSelected(const std::string& err,
                                               content::DesktopMediaID id) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (!err.empty()) {
    SupportToolError error = {
        SupportToolErrorCode::kDataCollectorError,
        base::StringPrintf("ScreenshotDataCollector had error: %s",
                           err.c_str())};
    std::move(data_collector_done_callback_).Run(error);
    return;
  } else if (id.is_null()) {
    // User canceled the dialog.
    screenshot_base64_ = kCaptureCanceled;
    return;
  }
#if BUILDFLAG(IS_CHROMEOS)
  gfx::NativeWindow window = gfx::NativeWindow();
  switch (id.type) {
    case content::DesktopMediaID::Type::TYPE_WEB_CONTENTS: {
      window = content::RenderFrameHost::FromID(
                   id.web_contents_id.render_process_id,
                   id.web_contents_id.main_render_frame_id)
                   ->GetNativeView();
      break;
    }
    case content::DesktopMediaID::Type::TYPE_WINDOW:
    case content::DesktopMediaID::Type::TYPE_SCREEN: {
      window = content::DesktopMediaID::GetNativeWindowById(id);
      break;
    }
    default: {
      NOTREACHED();
    }
  }
  const gfx::Rect bounds(window->bounds().width(), window->bounds().height());
  ui::GrabWindowSnapshotAsJPEG(
      std::move(window), std::move(bounds),
      base::BindOnce(&ScreenshotDataCollector::OnScreenshotTaken,
                     weak_ptr_factory_.GetWeakPtr()));
  return;
#else
  switch (id.type) {
    case content::DesktopMediaID::Type::TYPE_WEB_CONTENTS: {
      content::RenderFrameHost* const host = content::RenderFrameHost::FromID(
          id.web_contents_id.render_process_id,
          id.web_contents_id.main_render_frame_id);
      content::RenderWidgetHostView* const view =
          host ? host->GetView() : nullptr;
      if (!view) {
        SupportToolError error = {
            SupportToolErrorCode::kDataCollectorError,
            "ScreenshotDataCollector had error: Cannot find selected tab."};
        std::move(data_collector_done_callback_).Run(error);
        return;
      }
      view->CopyFromSurface(
          gfx::Rect(), gfx::Size(),
          base::BindPostTask(
              content::GetUIThreadTaskRunner({}),
              base::BindOnce(&ScreenshotDataCollector::OnTabCaptured,
                             weak_ptr_factory_.GetWeakPtr())));
      return;
    }
    case content::DesktopMediaID::Type::TYPE_WINDOW: {
      desktop_capturer_ = content::desktop_capture::CreateWindowCapturer(
          content::desktop_capture::CreateDesktopCaptureOptions());
      break;
    }
    case content::DesktopMediaID::Type::TYPE_SCREEN: {
      desktop_capturer_ = content::desktop_capture::CreateScreenCapturer(
          content::desktop_capture::CreateDesktopCaptureOptions(),
          /*for_snapshot=*/true);
      break;
    }
    default:
      NOTREACHED();
  }
  desktop_capturer_->Start(this);
  if (!desktop_capturer_->SelectSource(id.id)) {
    SupportToolError error = {
        SupportToolErrorCode::kDataCollectorError,
        "ScreenshotDataCollector had error: Cannot capture source."};
    std::move(data_collector_done_callback_).Run(error);
    return;
  }
  desktop_capturer_->CaptureFrame();
#endif  // !BUILDFLAG(IS_CHROMEOS)
}

#if BUILDFLAG(IS_CHROMEOS)
void ScreenshotDataCollector::OnScreenshotTaken(
    scoped_refptr<base::RefCountedMemory> data) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (data && data.get()) {
    screenshot_base64_ =
        base::StrCat({kBase64Header, base::Base64Encode(*data)});
    std::move(data_collector_done_callback_).Run(/*error=*/std::nullopt);
    return;
  }
  SupportToolError error = {
      SupportToolErrorCode::kDataCollectorError,
      "ScreenshotDataCollector had error: Failed to take screenshot."};
  std::move(data_collector_done_callback_).Run(error);
}
#else
void ScreenshotDataCollector::OnTabCaptured(const SkBitmap& bitmap) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  std::optional<std::vector<uint8_t>> jpeg_encoded_data;
  if (bitmap.drawsNothing() ||
      !(jpeg_encoded_data = gfx::JPEGCodec::Encode(bitmap, kDefaultQuality))) {
    SupportToolError error = {
        SupportToolErrorCode::kDataCollectorError,
        "ScreenshotDataCollector had error: Tab capture failed."};
    std::move(data_collector_done_callback_).Run(error);
    return;
  }
  screenshot_base64_ =
      base::StrCat({kBase64Header,
                    base::Base64Encode(std::move(jpeg_encoded_data.value()))});
  std::move(data_collector_done_callback_).Run(/*error=*/std::nullopt);
}
#endif  // !BUILDFLAG(IS_CHROMEOS)

void ScreenshotDataCollector::OnCaptureResult(
    webrtc::DesktopCapturer::Result result,
    std::unique_ptr<webrtc::DesktopFrame> frame) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (result != webrtc::DesktopCapturer::Result::SUCCESS) {
    SupportToolError error = {
        SupportToolErrorCode::kDataCollectorError,
        "ScreenshotDataCollector had error: Cannot capture source."};
    std::move(data_collector_done_callback_).Run(error);
    return;
  }

  ConvertDesktopFrameToBase64JPEG(std::move(frame), screenshot_base64_);
  std::move(data_collector_done_callback_).Run(/*error=*/std::nullopt);
}

void ScreenshotDataCollector::ExportCollectedDataWithPII(
    std::set<redaction::PIIType> pii_types_to_keep,
    base::FilePath target_directory,
    scoped_refptr<base::SequencedTaskRunner> task_runner_for_redaction_tool,
    scoped_refptr<redaction::RedactionToolContainer> redaction_tool_container,
    DataCollectorDoneCallback on_exported_callback) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  data_collector_done_callback_ = std::move(on_exported_callback);
  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE, {base::MayBlock()},
      base::BindOnce(&WriteOutputFile, std::move(screenshot_base64_),
                     std::move(target_directory)
                         .Append(FILE_PATH_LITERAL("screenshot.jpg"))),
      base::BindOnce(&ScreenshotDataCollector::OnScreenshotExported,
                     weak_ptr_factory_.GetWeakPtr()));
}

void ScreenshotDataCollector::OnScreenshotExported(bool success) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (!success) {
    SupportToolError error = {
        SupportToolErrorCode::kDataExportError,
        "ScreenshotDataCollector had error: Failed when exporting screenshot."};
    std::move(data_collector_done_callback_).Run(error);
    return;
  }
  std::move(data_collector_done_callback_).Run(/*error=*/std::nullopt);
}