blob: 718f88d86da43f8307e79900a0889b3d6e9ee437 [file] [log] [blame]
Lei Zhang1ac47eb2015-12-21 11:04:44 -08001// Copyright 2015 PDFium Authors. All rights reserved.
Tom Sepez96d13342015-01-16 14:59:26 -08002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Wei Li091f7a02015-11-09 12:09:55 -08005#include "testing/embedder_test.h"
Tom Sepez96d13342015-01-16 14:59:26 -08006
Lei Zhanga98e3662018-02-07 20:28:35 +00007#include <memory>
Tom Sepez96d13342015-01-16 14:59:26 -08008#include <string>
9#include <utility>
Lei Zhangd69e0652019-04-13 00:39:35 +000010#include <vector>
Tom Sepez96d13342015-01-16 14:59:26 -080011
Lei Zhangd145e4b2018-10-12 18:54:31 +000012#include "core/fdrm/fx_crypt.h"
Tom Sepeze08d2b12018-04-25 18:49:32 +000013#include "public/cpp/fpdf_scopers.h"
Lei Zhangb4e7f302015-11-06 15:52:32 -080014#include "public/fpdf_dataavail.h"
Lei Zhang453d96b2015-12-31 13:13:10 -080015#include "public/fpdf_edit.h"
Lei Zhangb4e7f302015-11-06 15:52:32 -080016#include "public/fpdf_text.h"
17#include "public/fpdfview.h"
Tom Sepeza310e002015-02-27 13:03:07 -080018#include "testing/gmock/include/gmock/gmock.h"
Lei Zhangd50bdff2019-02-05 19:42:33 +000019#include "testing/test_loader.h"
Henrique Nakashimaf956bad2018-08-16 16:41:42 +000020#include "testing/utils/bitmap_saver.h"
Lei Zhangb6992dd2019-02-05 23:30:20 +000021#include "testing/utils/file_util.h"
Lei Zhang4c64e962019-02-05 19:24:12 +000022#include "testing/utils/hash.h"
Wei Li091f7a02015-11-09 12:09:55 -080023#include "testing/utils/path_service.h"
Tom Sepez25f33d02021-01-29 01:58:51 +000024#include "third_party/base/check.h"
Lei Zhang87e3d7a2021-06-17 19:40:28 +000025#include "third_party/base/containers/contains.h"
Lei Zhang30632072020-10-02 01:57:54 +000026#include "third_party/base/notreached.h"
Tom Sepezea03a7b2022-02-24 00:30:14 +000027#include "third_party/base/numerics/safe_conversions.h"
Tom Sepez452b4f32015-10-13 09:27:27 -070028
29#ifdef PDF_ENABLE_V8
Tom Sepezeaf9d212020-07-22 16:24:00 +000030#include "testing/v8_test_environment.h"
Lei Zhang8241df72015-11-06 14:38:48 -080031#include "v8/include/v8-platform.h"
Dan Sinclair61046b92016-02-18 14:48:48 -050032#include "v8/include/v8.h"
Tom Sepez452b4f32015-10-13 09:27:27 -070033#endif // PDF_ENABLE_V8
Tom Sepez96d13342015-01-16 14:59:26 -080034
Tom Sepez96d13342015-01-16 14:59:26 -080035namespace {
thestigc08cd7a2016-06-27 09:47:59 -070036
Jane Liu28fb7ba2017-08-02 21:45:57 -040037int GetBitmapBytesPerPixel(FPDF_BITMAP bitmap) {
Tom Sepez6dc12402020-01-07 21:02:17 +000038 return EmbedderTest::BytesPerPixelForFormat(FPDFBitmap_GetFormat(bitmap));
Jane Liu28fb7ba2017-08-02 21:45:57 -040039}
40
Lei Zhangf997abe2022-01-12 19:14:23 +000041#if BUILDFLAG(IS_WIN)
Lei Zhang614f1a02019-05-30 00:03:53 +000042int CALLBACK GetRecordProc(HDC hdc,
43 HANDLETABLE* handle_table,
44 const ENHMETARECORD* record,
45 int objects_count,
46 LPARAM param) {
47 auto& records = *reinterpret_cast<std::vector<const ENHMETARECORD*>*>(param);
48 records.push_back(record);
49 return 1;
50}
Lei Zhangf997abe2022-01-12 19:14:23 +000051#endif // BUILDFLAG(IS_WIN)
Lei Zhang614f1a02019-05-30 00:03:53 +000052
Tom Sepezb2ce4d32022-05-06 17:09:33 +000053// These "jump" into the delegate to do actual testing.
54void UnsupportedHandlerTrampoline(UNSUPPORT_INFO* info, int type) {
55 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
56 delegate->UnsupportedHandler(type);
57}
58
59int AlertTrampoline(IPDF_JSPLATFORM* platform,
60 FPDF_WIDESTRING message,
61 FPDF_WIDESTRING title,
62 int type,
63 int icon) {
64 auto* delegate = static_cast<EmbedderTest*>(platform)->GetDelegate();
65 return delegate->Alert(message, title, type, icon);
66}
67
68int SetTimerTrampoline(FPDF_FORMFILLINFO* info, int msecs, TimerCallback fn) {
69 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
70 return delegate->SetTimer(msecs, fn);
71}
72
73void KillTimerTrampoline(FPDF_FORMFILLINFO* info, int id) {
74 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
75 return delegate->KillTimer(id);
76}
77
78FPDF_PAGE GetPageTrampoline(FPDF_FORMFILLINFO* info,
79 FPDF_DOCUMENT document,
80 int page_index) {
81 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
82 return delegate->GetPage(info, document, page_index);
83}
84
85void DoURIActionTrampoline(FPDF_FORMFILLINFO* info, FPDF_BYTESTRING uri) {
86 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
87 return delegate->DoURIAction(uri);
88}
89
90void DoGoToActionTrampoline(FPDF_FORMFILLINFO* info,
91 int page_index,
92 int zoom_mode,
93 float* pos_array,
94 int array_size) {
95 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
96 return delegate->DoGoToAction(info, page_index, zoom_mode, pos_array,
97 array_size);
98}
99
100void OnFocusChangeTrampoline(FPDF_FORMFILLINFO* info,
101 FPDF_ANNOTATION annot,
102 int page_index) {
103 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
104 return delegate->OnFocusChange(info, annot, page_index);
105}
106
107void DoURIActionWithKeyboardModifierTrampoline(FPDF_FORMFILLINFO* info,
108 FPDF_BYTESTRING uri,
109 int modifiers) {
110 auto* delegate = static_cast<EmbedderTest*>(info)->GetDelegate();
111 return delegate->DoURIActionWithKeyboardModifier(info, uri, modifiers);
112}
113
114// These do nothing (but must return a reasonable default value).
115void InvalidateStub(FPDF_FORMFILLINFO* pThis,
116 FPDF_PAGE page,
117 double left,
118 double top,
119 double right,
120 double bottom) {}
121
122void OutputSelectedRectStub(FPDF_FORMFILLINFO* pThis,
123 FPDF_PAGE page,
124 double left,
125 double top,
126 double right,
127 double bottom) {}
128
129void SetCursorStub(FPDF_FORMFILLINFO* pThis, int nCursorType) {}
130
131FPDF_SYSTEMTIME GetLocalTimeStub(FPDF_FORMFILLINFO* pThis) {
132 return {122, 11, 6, 28, 12, 59, 59, 500};
133}
134
135void OnChangeStub(FPDF_FORMFILLINFO* pThis) {}
136
137FPDF_PAGE GetCurrentPageStub(FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT document) {
138 return GetPageTrampoline(pThis, document, 0);
139}
140
141int GetRotationStub(FPDF_FORMFILLINFO* pThis, FPDF_PAGE page) {
142 return 0;
143}
144
145void ExecuteNamedActionStub(FPDF_FORMFILLINFO* pThis, FPDF_BYTESTRING name) {}
146
147void SetTextFieldFocusStub(FPDF_FORMFILLINFO* pThis,
148 FPDF_WIDESTRING value,
149 FPDF_DWORD valueLen,
150 FPDF_BOOL is_focus) {}
151
152#ifdef PDF_ENABLE_XFA
153void DisplayCaretStub(FPDF_FORMFILLINFO* pThis,
154 FPDF_PAGE page,
155 FPDF_BOOL bVisible,
156 double left,
157 double top,
158 double right,
159 double bottom) {}
160
161int GetCurrentPageIndexStub(FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT document) {
162 return 0;
163}
164
165void SetCurrentPageStub(FPDF_FORMFILLINFO* pThis,
166 FPDF_DOCUMENT document,
167 int iCurPage) {}
168
169void GotoURLStub(FPDF_FORMFILLINFO* pThis,
170 FPDF_DOCUMENT document,
171 FPDF_WIDESTRING wsURL) {}
172
173void GetPageViewRectStub(FPDF_FORMFILLINFO* pThis,
174 FPDF_PAGE page,
175 double* left,
176 double* top,
177 double* right,
178 double* bottom) {
179 *left = 0.0;
180 *top = 0.0;
181 *right = 512.0;
182 *bottom = 512.0;
183}
184
185void PageEventStub(FPDF_FORMFILLINFO* pThis,
186 int page_count,
187 FPDF_DWORD event_type) {}
188
189FPDF_BOOL PopupMenuStub(FPDF_FORMFILLINFO* pThis,
190 FPDF_PAGE page,
191 FPDF_WIDGET hWidget,
192 int menuFlag,
193 float x,
194 float y) {
195 return true;
196}
197
198FPDF_FILEHANDLER* OpenFileStub(FPDF_FORMFILLINFO* pThis,
199 int fileFlag,
200 FPDF_WIDESTRING wsURL,
201 const char* mode) {
202 return nullptr;
203}
204
205void EmailToStub(FPDF_FORMFILLINFO* pThis,
206 FPDF_FILEHANDLER* fileHandler,
207 FPDF_WIDESTRING pTo,
208 FPDF_WIDESTRING pSubject,
209 FPDF_WIDESTRING pCC,
210 FPDF_WIDESTRING pBcc,
211 FPDF_WIDESTRING pMsg) {}
212
213void UploadToStub(FPDF_FORMFILLINFO* pThis,
214 FPDF_FILEHANDLER* fileHandler,
215 int fileFlag,
216 FPDF_WIDESTRING uploadTo) {}
217
218int GetPlatformStub(FPDF_FORMFILLINFO* pThis, void* platform, int length) {
219 return 0;
220}
221
222int GetLanguageStub(FPDF_FORMFILLINFO* pThis, void* language, int length) {
223 return 0;
224}
225
226FPDF_FILEHANDLER* DownloadFromURLStub(FPDF_FORMFILLINFO* pThis,
227 FPDF_WIDESTRING URL) {
228 return nullptr;
229}
230
231FPDF_BOOL PostRequestURLStub(FPDF_FORMFILLINFO* pThis,
232 FPDF_WIDESTRING wsURL,
233 FPDF_WIDESTRING wsData,
234 FPDF_WIDESTRING wsContentType,
235 FPDF_WIDESTRING wsEncode,
236 FPDF_WIDESTRING wsHeader,
237 FPDF_BSTR* response) {
Tom Sepez15d326e2022-05-06 18:13:44 +0000238 const char kString[] = "p\0o\0s\0t\0e\0d\0";
239 FPDF_BStr_Set(response, kString, sizeof(kString) - 1);
Tom Sepezb2ce4d32022-05-06 17:09:33 +0000240 return true;
241}
242
243FPDF_BOOL PutRequestURLStub(FPDF_FORMFILLINFO* pThis,
244 FPDF_WIDESTRING wsURL,
245 FPDF_WIDESTRING wsData,
246 FPDF_WIDESTRING wsEncode) {
247 return true;
248}
249#endif // PDF_ENABLE_XFA
250
thestigbcd3e532016-11-21 13:37:28 -0800251} // namespace
252
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700253EmbedderTest::EmbedderTest()
Tom Sepez7df04832020-05-18 22:09:31 +0000254 : default_delegate_(std::make_unique<EmbedderTest::Delegate>()),
Lei Zhang0729be22018-02-05 21:13:51 +0000255 delegate_(default_delegate_.get()) {
Nicolas Pena3ff54002017-07-05 11:55:35 -0400256 FPDF_FILEWRITE::version = 1;
257 FPDF_FILEWRITE::WriteBlock = WriteBlockCallback;
Tom Sepezf288bb12015-11-20 12:12:46 -0800258}
Tom Sepez96d13342015-01-16 14:59:26 -0800259
Lei Zhangea208512019-12-18 00:42:11 +0000260EmbedderTest::~EmbedderTest() = default;
Tom Sepezf288bb12015-11-20 12:12:46 -0800261
262void EmbedderTest::SetUp() {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700263 UNSUPPORT_INFO* info = static_cast<UNSUPPORT_INFO*>(this);
264 memset(info, 0, sizeof(UNSUPPORT_INFO));
265 info->version = 1;
266 info->FSDK_UnSupport_Handler = UnsupportedHandlerTrampoline;
267 FSDK_SetUnSpObjProcessHandler(info);
268}
Tom Sepez96d13342015-01-16 14:59:26 -0800269
270void EmbedderTest::TearDown() {
Lei Zhang75c81712018-02-08 17:22:39 +0000271 // Use an EXPECT_EQ() here and continue to let TearDown() finish as cleanly as
Tom Sepez25f33d02021-01-29 01:58:51 +0000272 // possible. This can fail when an DCHECK test fails in a test case.
Lei Zhang75c81712018-02-08 17:22:39 +0000273 EXPECT_EQ(0U, page_map_.size());
Lei Zhang9f72c452018-02-08 21:49:54 +0000274 EXPECT_EQ(0U, saved_page_map_.size());
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000275 if (document())
Tom Sepez38f725f2019-12-04 00:26:34 +0000276 CloseDocument();
Tom Sepez96d13342015-01-16 14:59:26 -0800277}
278
Lei Zhangb8b4a042021-11-05 00:04:25 +0000279void EmbedderTest::CreateEmptyDocument() {
Lei Zhang935fb862021-11-05 00:15:05 +0000280 CreateEmptyDocumentWithoutFormFillEnvironment();
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000281 form_handle_.reset(SetupFormFillEnvironment(
282 document(), JavaScriptOption::kEnableJavaScript));
Tom Sepezd483eb42016-01-06 10:03:59 -0800283}
284
Lei Zhang935fb862021-11-05 00:15:05 +0000285void EmbedderTest::CreateEmptyDocumentWithoutFormFillEnvironment() {
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000286 document_.reset(FPDF_CreateNewDocument());
Lei Zhang935fb862021-11-05 00:15:05 +0000287 DCHECK(document_);
288}
289
Lei Zhang208eecf2017-12-20 19:40:50 +0000290bool EmbedderTest::OpenDocument(const std::string& filename) {
Tom Sepez0784c732018-04-23 18:02:57 +0000291 return OpenDocumentWithOptions(filename, nullptr,
292 LinearizeOption::kDefaultLinearize,
293 JavaScriptOption::kEnableJavaScript);
Lei Zhang208eecf2017-12-20 19:40:50 +0000294}
295
296bool EmbedderTest::OpenDocumentLinearized(const std::string& filename) {
Tom Sepez0784c732018-04-23 18:02:57 +0000297 return OpenDocumentWithOptions(filename, nullptr,
298 LinearizeOption::kMustLinearize,
299 JavaScriptOption::kEnableJavaScript);
Lei Zhang208eecf2017-12-20 19:40:50 +0000300}
301
302bool EmbedderTest::OpenDocumentWithPassword(const std::string& filename,
303 const char* password) {
Tom Sepez0784c732018-04-23 18:02:57 +0000304 return OpenDocumentWithOptions(filename, password,
305 LinearizeOption::kDefaultLinearize,
306 JavaScriptOption::kEnableJavaScript);
307}
308
309bool EmbedderTest::OpenDocumentWithoutJavaScript(const std::string& filename) {
310 return OpenDocumentWithOptions(filename, nullptr,
311 LinearizeOption::kDefaultLinearize,
312 JavaScriptOption::kDisableJavaScript);
Lei Zhang208eecf2017-12-20 19:40:50 +0000313}
314
315bool EmbedderTest::OpenDocumentWithOptions(const std::string& filename,
316 const char* password,
Tom Sepez0784c732018-04-23 18:02:57 +0000317 LinearizeOption linearize_option,
318 JavaScriptOption javascript_option) {
Wei Li091f7a02015-11-09 12:09:55 -0800319 std::string file_path;
320 if (!PathService::GetTestFilePath(filename, &file_path))
321 return false;
Tom Sepez0784c732018-04-23 18:02:57 +0000322
Wei Li091f7a02015-11-09 12:09:55 -0800323 file_contents_ = GetFileContents(file_path.c_str(), &file_length_);
Dan Sinclair6be2aab2015-10-28 13:58:49 -0400324 if (!file_contents_)
Tom Sepez96d13342015-01-16 14:59:26 -0800325 return false;
Tom Sepez96d13342015-01-16 14:59:26 -0800326
thestig29ce9232016-06-22 07:03:23 -0700327 EXPECT_TRUE(!loader_);
Tom Sepez7df04832020-05-18 22:09:31 +0000328 loader_ = std::make_unique<TestLoader>(
Lei Zhangb3be4a12019-02-05 22:11:07 +0000329 pdfium::make_span(file_contents_.get(), file_length_));
Lei Zhang0729be22018-02-05 21:13:51 +0000330
331 memset(&file_access_, 0, sizeof(file_access_));
Tom Sepez96d13342015-01-16 14:59:26 -0800332 file_access_.m_FileLen = static_cast<unsigned long>(file_length_);
Tom Sepezd831dc72015-10-19 16:04:22 -0700333 file_access_.m_GetBlock = TestLoader::GetBlock;
Lei Zhangb3be4a12019-02-05 22:11:07 +0000334 file_access_.m_Param = loader_.get();
Lei Zhang0729be22018-02-05 21:13:51 +0000335
Tom Sepez7df04832020-05-18 22:09:31 +0000336 fake_file_access_ = std::make_unique<FakeFileAccess>(&file_access_);
Tom Sepez0784c732018-04-23 18:02:57 +0000337 return OpenDocumentHelper(password, linearize_option, javascript_option,
338 fake_file_access_.get(), &document_, &avail_,
339 &form_handle_);
Nicolas Pena56fc9722017-07-13 16:31:34 -0400340}
Tom Sepez96d13342015-01-16 14:59:26 -0800341
Nicolas Pena56fc9722017-07-13 16:31:34 -0400342bool EmbedderTest::OpenDocumentHelper(const char* password,
Tom Sepez0784c732018-04-23 18:02:57 +0000343 LinearizeOption linearize_option,
344 JavaScriptOption javascript_option,
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300345 FakeFileAccess* network_simulator,
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000346 ScopedFPDFDocument* document,
Lei Zhang52d21ac2021-11-04 22:40:15 +0000347 ScopedFPDFAvail* avail,
Lei Zhangdba065e2021-11-04 23:09:15 +0000348 ScopedFPDFFormHandle* form_handle) {
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300349 network_simulator->AddSegment(0, 1024);
350 network_simulator->SetRequestedDataAvailable();
Lei Zhang52d21ac2021-11-04 22:40:15 +0000351 avail->reset(FPDFAvail_Create(network_simulator->GetFileAvail(),
352 network_simulator->GetFileAccess()));
353 FPDF_AVAIL avail_ptr = avail->get();
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000354 FPDF_DOCUMENT document_ptr = nullptr;
Lei Zhang52d21ac2021-11-04 22:40:15 +0000355 if (FPDFAvail_IsLinearized(avail_ptr) == PDF_LINEARIZED) {
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300356 int32_t nRet = PDF_DATA_NOTAVAIL;
357 while (nRet == PDF_DATA_NOTAVAIL) {
358 network_simulator->SetRequestedDataAvailable();
Lei Zhang52d21ac2021-11-04 22:40:15 +0000359 nRet = FPDFAvail_IsDocAvail(avail_ptr,
360 network_simulator->GetDownloadHints());
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300361 }
362 if (nRet == PDF_DATA_ERROR)
363 return false;
364
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000365 document->reset(FPDFAvail_GetDocument(avail_ptr, password));
366 document_ptr = document->get();
367 if (!document_ptr)
Jun Fangdf7f3662015-11-10 18:29:18 +0800368 return false;
Nicolas Pena56fc9722017-07-13 16:31:34 -0400369
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300370 nRet = PDF_DATA_NOTAVAIL;
371 while (nRet == PDF_DATA_NOTAVAIL) {
372 network_simulator->SetRequestedDataAvailable();
Lei Zhang52d21ac2021-11-04 22:40:15 +0000373 nRet = FPDFAvail_IsFormAvail(avail_ptr,
374 network_simulator->GetDownloadHints());
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300375 }
376 if (nRet == PDF_FORM_ERROR)
Jun Fangdf7f3662015-11-10 18:29:18 +0800377 return false;
Nicolas Pena56fc9722017-07-13 16:31:34 -0400378
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000379 int page_count = FPDF_GetPageCount(document_ptr);
Jun Fangdf7f3662015-11-10 18:29:18 +0800380 for (int i = 0; i < page_count; ++i) {
381 nRet = PDF_DATA_NOTAVAIL;
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300382 while (nRet == PDF_DATA_NOTAVAIL) {
383 network_simulator->SetRequestedDataAvailable();
Lei Zhang52d21ac2021-11-04 22:40:15 +0000384 nRet = FPDFAvail_IsPageAvail(avail_ptr, i,
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300385 network_simulator->GetDownloadHints());
386 }
Nicolas Pena56fc9722017-07-13 16:31:34 -0400387 if (nRet == PDF_DATA_ERROR)
Jun Fangdf7f3662015-11-10 18:29:18 +0800388 return false;
Jun Fangdf7f3662015-11-10 18:29:18 +0800389 }
390 } else {
Tom Sepez0784c732018-04-23 18:02:57 +0000391 if (linearize_option == LinearizeOption::kMustLinearize)
Jun Fangdf7f3662015-11-10 18:29:18 +0800392 return false;
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300393 network_simulator->SetWholeFileAvailable();
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000394 document->reset(
395 FPDF_LoadCustomDocument(network_simulator->GetFileAccess(), password));
396 document_ptr = document->get();
397 if (!document_ptr)
Jun Fangdf7f3662015-11-10 18:29:18 +0800398 return false;
Jun Fangdf7f3662015-11-10 18:29:18 +0800399 }
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000400 form_handle->reset(SetupFormFillEnvironment(document_ptr, javascript_option));
Tom Sepez0784c732018-04-23 18:02:57 +0000401
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000402 int doc_type = FPDF_GetFormType(document_ptr);
Ryan Harrison854d71c2017-10-18 12:28:14 -0400403 if (doc_type == FORMTYPE_XFA_FULL || doc_type == FORMTYPE_XFA_FOREGROUND)
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000404 FPDF_LoadXFA(document_ptr);
Tom Sepez0784c732018-04-23 18:02:57 +0000405
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000406 (void)FPDF_GetDocPermissions(document_ptr);
Tom Sepezd483eb42016-01-06 10:03:59 -0800407 return true;
408}
Tom Sepez96d13342015-01-16 14:59:26 -0800409
Tom Sepez38f725f2019-12-04 00:26:34 +0000410void EmbedderTest::CloseDocument() {
Lei Zhangdba065e2021-11-04 23:09:15 +0000411 FORM_DoDocumentAAction(form_handle(), FPDFDOC_AACTION_WC);
412 form_handle_.reset();
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000413 document_.reset();
Lei Zhang55b1f462021-11-05 01:44:46 +0000414 avail_.reset();
415 fake_file_access_.reset();
416 memset(&file_access_, 0, sizeof(file_access_));
417 loader_.reset();
418 file_contents_.reset();
Tom Sepez38f725f2019-12-04 00:26:34 +0000419}
420
Tom Sepez0784c732018-04-23 18:02:57 +0000421FPDF_FORMHANDLE EmbedderTest::SetupFormFillEnvironment(
422 FPDF_DOCUMENT doc,
423 JavaScriptOption javascript_option) {
Tom Sepez4cb0fa72015-02-25 16:08:18 -0800424 IPDF_JSPLATFORM* platform = static_cast<IPDF_JSPLATFORM*>(this);
Nicolas Pena3ff54002017-07-05 11:55:35 -0400425 memset(platform, '\0', sizeof(IPDF_JSPLATFORM));
Tom Sepez72f520c2020-08-24 23:43:46 +0000426 platform->version = 3;
Tom Sepez4cb0fa72015-02-25 16:08:18 -0800427 platform->app_alert = AlertTrampoline;
Tom Sepez96d13342015-01-16 14:59:26 -0800428
Tom Sepez4cb0fa72015-02-25 16:08:18 -0800429 FPDF_FORMFILLINFO* formfillinfo = static_cast<FPDF_FORMFILLINFO*>(this);
430 memset(formfillinfo, 0, sizeof(FPDF_FORMFILLINFO));
Aayush Dhirc63913e2020-02-12 09:45:34 +0000431 formfillinfo->version = form_fill_info_version_;
Tom Sepezb2ce4d32022-05-06 17:09:33 +0000432 formfillinfo->FFI_Invalidate = InvalidateStub;
433 formfillinfo->FFI_OutputSelectedRect = OutputSelectedRectStub;
434 formfillinfo->FFI_SetCursor = SetCursorStub;
Tom Sepez6efc0ad2015-06-02 17:11:18 -0700435 formfillinfo->FFI_SetTimer = SetTimerTrampoline;
436 formfillinfo->FFI_KillTimer = KillTimerTrampoline;
Tom Sepezb2ce4d32022-05-06 17:09:33 +0000437 formfillinfo->FFI_GetLocalTime = GetLocalTimeStub;
438 formfillinfo->FFI_OnChange = OnChangeStub;
Tom Sepez396e8722015-09-09 10:16:08 -0700439 formfillinfo->FFI_GetPage = GetPageTrampoline;
Tom Sepezb2ce4d32022-05-06 17:09:33 +0000440 formfillinfo->FFI_GetCurrentPage = GetCurrentPageStub;
441 formfillinfo->FFI_GetRotation = GetRotationStub;
442 formfillinfo->FFI_ExecuteNamedAction = ExecuteNamedActionStub;
443 formfillinfo->FFI_SetTextFieldFocus = SetTextFieldFocusStub;
Henrique Nakashima9ef93d02018-10-03 18:41:03 +0000444 formfillinfo->FFI_DoURIAction = DoURIActionTrampoline;
Badhri Ravikumarf5cc1ac2020-04-30 19:00:55 +0000445 formfillinfo->FFI_DoGoToAction = DoGoToActionTrampoline;
Tom Sepezb2ce4d32022-05-06 17:09:33 +0000446#ifdef PDF_ENABLE_XFA
447 formfillinfo->FFI_DisplayCaret = DisplayCaretStub;
448 formfillinfo->FFI_GetCurrentPageIndex = GetCurrentPageIndexStub;
449 formfillinfo->FFI_SetCurrentPage = SetCurrentPageStub;
450 formfillinfo->FFI_GotoURL = GotoURLStub;
451 formfillinfo->FFI_GetPageViewRect = GetPageViewRectStub;
452 formfillinfo->FFI_PageEvent = PageEventStub;
453 formfillinfo->FFI_PopupMenu = PopupMenuStub;
454 formfillinfo->FFI_OpenFile = OpenFileStub;
455 formfillinfo->FFI_EmailTo = EmailToStub;
456 formfillinfo->FFI_UploadTo = UploadToStub;
457 formfillinfo->FFI_GetPlatform = GetPlatformStub;
458 formfillinfo->FFI_GetLanguage = GetLanguageStub;
459 formfillinfo->FFI_DownloadFromURL = DownloadFromURLStub;
460 formfillinfo->FFI_PostRequestURL = PostRequestURLStub;
461 formfillinfo->FFI_PutRequestURL = PutRequestURLStub;
462#endif // PDF_ENABLE_XFA
Aayush Dhirc63913e2020-02-12 09:45:34 +0000463 formfillinfo->FFI_OnFocusChange = OnFocusChangeTrampoline;
Badhri Ravikumare86bbfa2020-04-16 21:42:40 +0000464 formfillinfo->FFI_DoURIActionWithKeyboardModifier =
465 DoURIActionWithKeyboardModifierTrampoline;
Henrique Nakashima9ef93d02018-10-03 18:41:03 +0000466
Tom Sepez0784c732018-04-23 18:02:57 +0000467 if (javascript_option == JavaScriptOption::kEnableJavaScript)
468 formfillinfo->m_pJsPlatform = platform;
469
Nicolas Pena3ff54002017-07-05 11:55:35 -0400470 FPDF_FORMHANDLE form_handle =
471 FPDFDOC_InitFormFillEnvironment(doc, formfillinfo);
Tom Sepez92f92222020-01-07 22:16:07 +0000472 SetInitialFormFieldHighlight(form_handle);
Nicolas Pena3ff54002017-07-05 11:55:35 -0400473 return form_handle;
Tom Sepez96d13342015-01-16 14:59:26 -0800474}
475
Tom Sepezda8189e2015-01-30 14:41:50 -0800476void EmbedderTest::DoOpenActions() {
Lei Zhangdba065e2021-11-04 23:09:15 +0000477 DCHECK(form_handle());
478 FORM_DoDocumentJSAction(form_handle());
479 FORM_DoDocumentOpenAction(form_handle());
Tom Sepez96d13342015-01-16 14:59:26 -0800480}
481
482int EmbedderTest::GetFirstPageNum() {
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000483 int first_page = FPDFAvail_GetFirstPageNum(document());
Lei Zhang52d21ac2021-11-04 22:40:15 +0000484 (void)FPDFAvail_IsPageAvail(avail(), first_page,
Ryan Harrison6cec70a2018-06-05 14:06:10 +0000485 fake_file_access_->GetDownloadHints());
Tom Sepez96d13342015-01-16 14:59:26 -0800486 return first_page;
487}
488
489int EmbedderTest::GetPageCount() {
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000490 int page_count = FPDF_GetPageCount(document());
Nicolas Pena3ff54002017-07-05 11:55:35 -0400491 for (int i = 0; i < page_count; ++i)
Lei Zhang52d21ac2021-11-04 22:40:15 +0000492 (void)FPDFAvail_IsPageAvail(avail(), i,
Ryan Harrison6cec70a2018-06-05 14:06:10 +0000493 fake_file_access_->GetDownloadHints());
Tom Sepez96d13342015-01-16 14:59:26 -0800494 return page_count;
495}
496
Tom Sepezda8189e2015-01-30 14:41:50 -0800497FPDF_PAGE EmbedderTest::LoadPage(int page_number) {
Tom Sepez507d0192018-11-07 16:37:51 +0000498 return LoadPageCommon(page_number, true);
499}
500
501FPDF_PAGE EmbedderTest::LoadPageNoEvents(int page_number) {
502 return LoadPageCommon(page_number, false);
503}
504
505FPDF_PAGE EmbedderTest::LoadPageCommon(int page_number, bool do_events) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000506 DCHECK(form_handle());
Tom Sepez25f33d02021-01-29 01:58:51 +0000507 DCHECK(page_number >= 0);
508 DCHECK(!pdfium::Contains(page_map_, page_number));
weili0dadcc62016-08-23 21:10:57 -0700509
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000510 FPDF_PAGE page = FPDF_LoadPage(document(), page_number);
Nicolas Pena3ff54002017-07-05 11:55:35 -0400511 if (!page)
Tom Sepez96d13342015-01-16 14:59:26 -0800512 return nullptr;
Nicolas Pena3ff54002017-07-05 11:55:35 -0400513
Tom Sepez507d0192018-11-07 16:37:51 +0000514 if (do_events) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000515 FORM_OnAfterLoadPage(page, form_handle());
516 FORM_DoPageAAction(page, form_handle(), FPDFPAGE_AACTION_OPEN);
Tom Sepez507d0192018-11-07 16:37:51 +0000517 }
weili0dadcc62016-08-23 21:10:57 -0700518 page_map_[page_number] = page;
Tom Sepez396e8722015-09-09 10:16:08 -0700519 return page;
520}
521
Tom Sepezda8189e2015-01-30 14:41:50 -0800522void EmbedderTest::UnloadPage(FPDF_PAGE page) {
Tom Sepez507d0192018-11-07 16:37:51 +0000523 UnloadPageCommon(page, true);
524}
Lei Zhang75c81712018-02-08 17:22:39 +0000525
Tom Sepez507d0192018-11-07 16:37:51 +0000526void EmbedderTest::UnloadPageNoEvents(FPDF_PAGE page) {
527 UnloadPageCommon(page, false);
528}
529
530void EmbedderTest::UnloadPageCommon(FPDF_PAGE page, bool do_events) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000531 DCHECK(form_handle());
Lei Zhang75c81712018-02-08 17:22:39 +0000532 int page_number = GetPageNumberForLoadedPage(page);
533 if (page_number < 0) {
534 NOTREACHED();
535 return;
536 }
Tom Sepez507d0192018-11-07 16:37:51 +0000537 if (do_events) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000538 FORM_DoPageAAction(page, form_handle(), FPDFPAGE_AACTION_CLOSE);
539 FORM_OnBeforeClosePage(page, form_handle());
Tom Sepez507d0192018-11-07 16:37:51 +0000540 }
Tom Sepez96d13342015-01-16 14:59:26 -0800541 FPDF_ClosePage(page);
Lei Zhang75c81712018-02-08 17:22:39 +0000542 page_map_.erase(page_number);
Tom Sepez96d13342015-01-16 14:59:26 -0800543}
Tom Sepez1b1bb492015-01-22 17:36:32 -0800544
Tom Sepez92f92222020-01-07 22:16:07 +0000545void EmbedderTest::SetInitialFormFieldHighlight(FPDF_FORMHANDLE form) {
546 FPDF_SetFormFieldHighlightColor(form, FPDF_FORMFIELD_UNKNOWN, 0xFFE4DD);
547 FPDF_SetFormFieldHighlightAlpha(form, 100);
548}
549
Tom Sepeze08d2b12018-04-25 18:49:32 +0000550ScopedFPDFBitmap EmbedderTest::RenderLoadedPage(FPDF_PAGE page) {
Lei Zhanga98e3662018-02-07 20:28:35 +0000551 return RenderLoadedPageWithFlags(page, 0);
552}
553
Tom Sepeze08d2b12018-04-25 18:49:32 +0000554ScopedFPDFBitmap EmbedderTest::RenderLoadedPageWithFlags(FPDF_PAGE page,
555 int flags) {
Lei Zhang75c81712018-02-08 17:22:39 +0000556 if (GetPageNumberForLoadedPage(page) < 0) {
557 NOTREACHED();
558 return nullptr;
559 }
Lei Zhangdba065e2021-11-04 23:09:15 +0000560 return RenderPageWithFlags(page, form_handle(), flags);
Lei Zhanga98e3662018-02-07 20:28:35 +0000561}
562
Tom Sepeze08d2b12018-04-25 18:49:32 +0000563ScopedFPDFBitmap EmbedderTest::RenderSavedPage(FPDF_PAGE page) {
Lei Zhanga98e3662018-02-07 20:28:35 +0000564 return RenderSavedPageWithFlags(page, 0);
565}
566
Tom Sepeze08d2b12018-04-25 18:49:32 +0000567ScopedFPDFBitmap EmbedderTest::RenderSavedPageWithFlags(FPDF_PAGE page,
568 int flags) {
Lei Zhang9f72c452018-02-08 21:49:54 +0000569 if (GetPageNumberForSavedPage(page) < 0) {
570 NOTREACHED();
571 return nullptr;
572 }
Lei Zhangdba065e2021-11-04 23:09:15 +0000573 return RenderPageWithFlags(page, saved_form_handle(), flags);
Lei Zhanga98e3662018-02-07 20:28:35 +0000574}
575
576// static
Tom Sepeze08d2b12018-04-25 18:49:32 +0000577ScopedFPDFBitmap EmbedderTest::RenderPageWithFlags(FPDF_PAGE page,
578 FPDF_FORMHANDLE handle,
579 int flags) {
Lei Zhangdfa075b2019-12-05 21:52:43 +0000580 int width = static_cast<int>(FPDF_GetPageWidthF(page));
581 int height = static_cast<int>(FPDF_GetPageHeightF(page));
Lei Zhanga98e3662018-02-07 20:28:35 +0000582 int alpha = FPDFPage_HasTransparency(page) ? 1 : 0;
Tom Sepeze08d2b12018-04-25 18:49:32 +0000583 ScopedFPDFBitmap bitmap(FPDFBitmap_Create(width, height, alpha));
Lei Zhanga98e3662018-02-07 20:28:35 +0000584 FPDF_DWORD fill_color = alpha ? 0x00000000 : 0xFFFFFFFF;
585 FPDFBitmap_FillRect(bitmap.get(), 0, 0, width, height, fill_color);
586 FPDF_RenderPageBitmap(bitmap.get(), page, 0, 0, width, height, 0, flags);
587 FPDF_FFLDraw(handle, bitmap.get(), page, 0, 0, width, height, 0, flags);
588 return bitmap;
589}
590
Lei Zhang30ff2532019-01-31 21:37:55 +0000591// static
592ScopedFPDFBitmap EmbedderTest::RenderPage(FPDF_PAGE page) {
593 return RenderPageWithFlags(page, nullptr, 0);
594}
595
Lei Zhangf997abe2022-01-12 19:14:23 +0000596#if BUILDFLAG(IS_WIN)
Lei Zhangd69e0652019-04-13 00:39:35 +0000597// static
598std::vector<uint8_t> EmbedderTest::RenderPageWithFlagsToEmf(FPDF_PAGE page,
599 int flags) {
600 HDC dc = CreateEnhMetaFileA(nullptr, nullptr, nullptr, nullptr);
601
Lei Zhangdfa075b2019-12-05 21:52:43 +0000602 int width = static_cast<int>(FPDF_GetPageWidthF(page));
603 int height = static_cast<int>(FPDF_GetPageHeightF(page));
Lei Zhangd69e0652019-04-13 00:39:35 +0000604 HRGN rgn = CreateRectRgn(0, 0, width, height);
605 SelectClipRgn(dc, rgn);
606 DeleteObject(rgn);
607
608 SelectObject(dc, GetStockObject(NULL_PEN));
609 SelectObject(dc, GetStockObject(WHITE_BRUSH));
610 // If a PS_NULL pen is used, the dimensions of the rectangle are 1 pixel less.
611 Rectangle(dc, 0, 0, width + 1, height + 1);
612
613 FPDF_RenderPage(dc, page, 0, 0, width, height, 0, flags);
614
615 HENHMETAFILE emf = CloseEnhMetaFile(dc);
Tom Sepezea03a7b2022-02-24 00:30:14 +0000616 UINT size_in_bytes = GetEnhMetaFileBits(emf, 0, nullptr);
Lei Zhangd69e0652019-04-13 00:39:35 +0000617 std::vector<uint8_t> buffer(size_in_bytes);
618 GetEnhMetaFileBits(emf, size_in_bytes, buffer.data());
619 DeleteEnhMetaFile(emf);
620 return buffer;
621}
Lei Zhang614f1a02019-05-30 00:03:53 +0000622
623// static
624std::string EmbedderTest::GetPostScriptFromEmf(
Tom Sepez87b9e3a2019-11-20 23:45:43 +0000625 pdfium::span<const uint8_t> emf_data) {
Lei Zhang614f1a02019-05-30 00:03:53 +0000626 // This comes from Emf::InitFromData() in Chromium.
Tom Sepezea03a7b2022-02-24 00:30:14 +0000627 HENHMETAFILE emf = SetEnhMetaFileBits(
628 pdfium::base::checked_cast<UINT>(emf_data.size()), emf_data.data());
Lei Zhang614f1a02019-05-30 00:03:53 +0000629 if (!emf)
630 return std::string();
631
632 // This comes from Emf::Enumerator::Enumerator() in Chromium.
633 std::vector<const ENHMETARECORD*> records;
634 if (!EnumEnhMetaFile(nullptr, emf, &GetRecordProc, &records, nullptr)) {
635 DeleteEnhMetaFile(emf);
636 return std::string();
637 }
638
639 // This comes from PostScriptMetaFile::SafePlayback() in Chromium.
640 std::string ps_data;
641 for (const auto* record : records) {
642 if (record->iType != EMR_GDICOMMENT)
643 continue;
644
645 // PostScript data is encapsulated inside EMF comment records.
646 // The first two bytes of the comment indicate the string length. The rest
647 // is the actual string data.
648 const auto* comment = reinterpret_cast<const EMRGDICOMMENT*>(record);
649 const char* data = reinterpret_cast<const char*>(comment->Data);
650 uint16_t size = *reinterpret_cast<const uint16_t*>(data);
651 data += 2;
652 ps_data.append(data, size);
653 }
654 DeleteEnhMetaFile(emf);
655 return ps_data;
656}
Lei Zhangf997abe2022-01-12 19:14:23 +0000657#endif // BUILDFLAG(IS_WIN)
Lei Zhangd69e0652019-04-13 00:39:35 +0000658
Lei Zhang0b494052019-01-31 21:41:15 +0000659FPDF_DOCUMENT EmbedderTest::OpenSavedDocument() {
660 return OpenSavedDocumentWithPassword(nullptr);
661}
662
Tom Sepez6dc12402020-01-07 21:02:17 +0000663// static
664int EmbedderTest::BytesPerPixelForFormat(int format) {
665 switch (format) {
666 case FPDFBitmap_Gray:
667 return 1;
668 case FPDFBitmap_BGR:
669 return 3;
670 case FPDFBitmap_BGRx:
671 case FPDFBitmap_BGRA:
672 return 4;
673 default:
674 NOTREACHED();
675 return 0;
676 }
677}
678
Lei Zhang0b494052019-01-31 21:41:15 +0000679FPDF_DOCUMENT EmbedderTest::OpenSavedDocumentWithPassword(
680 const char* password) {
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300681 memset(&saved_file_access_, 0, sizeof(saved_file_access_));
Tom Sepezea03a7b2022-02-24 00:30:14 +0000682 saved_file_access_.m_FileLen =
683 pdfium::base::checked_cast<unsigned long>(data_string_.size());
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300684 saved_file_access_.m_GetBlock = GetBlockFromString;
Artem Strygin68d04f22018-07-12 09:18:19 +0000685 // Copy data to prevent clearing it before saved document close.
686 saved_document_file_data_ = data_string_;
687 saved_file_access_.m_Param = &saved_document_file_data_;
Nicolas Pena3ff54002017-07-05 11:55:35 -0400688
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300689 saved_fake_file_access_ =
Tom Sepez7df04832020-05-18 22:09:31 +0000690 std::make_unique<FakeFileAccess>(&saved_file_access_);
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300691
Tom Sepez0784c732018-04-23 18:02:57 +0000692 EXPECT_TRUE(OpenDocumentHelper(
693 password, LinearizeOption::kDefaultLinearize,
694 JavaScriptOption::kEnableJavaScript, saved_fake_file_access_.get(),
695 &saved_document_, &saved_avail_, &saved_form_handle_));
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000696 return saved_document();
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400697}
698
699void EmbedderTest::CloseSavedDocument() {
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000700 DCHECK(saved_document());
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400701
Lei Zhangdba065e2021-11-04 23:09:15 +0000702 saved_form_handle_.reset();
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000703 saved_document_.reset();
Lei Zhang52d21ac2021-11-04 22:40:15 +0000704 saved_avail_.reset();
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400705}
706
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000707FPDF_PAGE EmbedderTest::LoadSavedPage(int page_number) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000708 DCHECK(saved_form_handle());
Tom Sepez25f33d02021-01-29 01:58:51 +0000709 DCHECK(page_number >= 0);
710 DCHECK(!pdfium::Contains(saved_page_map_, page_number));
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400711
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000712 FPDF_PAGE page = FPDF_LoadPage(saved_document(), page_number);
Lei Zhang9f72c452018-02-08 21:49:54 +0000713 if (!page)
714 return nullptr;
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400715
Lei Zhangdba065e2021-11-04 23:09:15 +0000716 FORM_OnAfterLoadPage(page, saved_form_handle());
717 FORM_DoPageAAction(page, saved_form_handle(), FPDFPAGE_AACTION_OPEN);
Lei Zhang9f72c452018-02-08 21:49:54 +0000718 saved_page_map_[page_number] = page;
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000719 return page;
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400720}
721
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000722void EmbedderTest::CloseSavedPage(FPDF_PAGE page) {
Lei Zhangdba065e2021-11-04 23:09:15 +0000723 DCHECK(saved_form_handle());
Lei Zhang9f72c452018-02-08 21:49:54 +0000724
725 int page_number = GetPageNumberForSavedPage(page);
726 if (page_number < 0) {
727 NOTREACHED();
728 return;
729 }
730
Lei Zhangdba065e2021-11-04 23:09:15 +0000731 FORM_DoPageAAction(page, saved_form_handle(), FPDFPAGE_AACTION_CLOSE);
732 FORM_OnBeforeClosePage(page, saved_form_handle());
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000733 FPDF_ClosePage(page);
Lei Zhang9f72c452018-02-08 21:49:54 +0000734
735 saved_page_map_.erase(page_number);
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400736}
737
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000738void EmbedderTest::VerifySavedRendering(FPDF_PAGE page,
739 int width,
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400740 int height,
741 const char* md5) {
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000742 DCHECK(saved_document());
Tom Sepez25f33d02021-01-29 01:58:51 +0000743 DCHECK(page);
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400744
Tom Sepeze08d2b12018-04-25 18:49:32 +0000745 ScopedFPDFBitmap bitmap = RenderSavedPageWithFlags(page, FPDF_ANNOT);
Lei Zhanga98e3662018-02-07 20:28:35 +0000746 CompareBitmap(bitmap.get(), width, height, md5);
Nicolas Pena3ff54002017-07-05 11:55:35 -0400747}
748
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400749void EmbedderTest::VerifySavedDocument(int width, int height, const char* md5) {
Lei Zhang0b494052019-01-31 21:41:15 +0000750 ASSERT_TRUE(OpenSavedDocument());
Henrique Nakashima8baea3c2017-11-10 20:27:23 +0000751 FPDF_PAGE page = LoadSavedPage(0);
752 VerifySavedRendering(page, width, height, md5);
753 CloseSavedPage(page);
Dan Sinclair04e4dc82017-10-18 12:17:14 -0400754 CloseSavedDocument();
Nicolas Pena3ff54002017-07-05 11:55:35 -0400755}
756
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300757void EmbedderTest::SetWholeFileAvailable() {
Tom Sepez25f33d02021-01-29 01:58:51 +0000758 DCHECK(fake_file_access_);
Artem Strygin0e60b9e2017-09-28 18:46:03 +0300759 fake_file_access_->SetWholeFileAvailable();
760}
761
Lei Zhang38e2b0e2021-11-05 00:28:05 +0000762void EmbedderTest::SetDocumentFromAvail() {
763 document_.reset(FPDFAvail_GetDocument(avail(), nullptr));
764}
765
Lei Zhang52d21ac2021-11-04 22:40:15 +0000766void EmbedderTest::CreateAvail(FX_FILEAVAIL* file_avail,
767 FPDF_FILEACCESS* file) {
768 avail_.reset(FPDFAvail_Create(file_avail, file));
769}
770
weili0dadcc62016-08-23 21:10:57 -0700771FPDF_PAGE EmbedderTest::Delegate::GetPage(FPDF_FORMFILLINFO* info,
Tom Sepez396e8722015-09-09 10:16:08 -0700772 FPDF_DOCUMENT document,
773 int page_index) {
weili0dadcc62016-08-23 21:10:57 -0700774 EmbedderTest* test = static_cast<EmbedderTest*>(info);
775 auto it = test->page_map_.find(page_index);
776 return it != test->page_map_.end() ? it->second : nullptr;
Tom Sepez396e8722015-09-09 10:16:08 -0700777}
778
Tom Sepez4cb0fa72015-02-25 16:08:18 -0800779// static
Henrique Nakashima9fa50362017-11-10 22:40:44 +0000780std::string EmbedderTest::HashBitmap(FPDF_BITMAP bitmap) {
Lei Zhangbf980142019-12-20 01:05:42 +0000781 int stride = FPDFBitmap_GetStride(bitmap);
782 int usable_bytes_per_row =
783 GetBitmapBytesPerPixel(bitmap) * FPDFBitmap_GetWidth(bitmap);
784 int height = FPDFBitmap_GetHeight(bitmap);
785 auto span = pdfium::make_span(
786 static_cast<uint8_t*>(FPDFBitmap_GetBuffer(bitmap)), stride * height);
787
788 CRYPT_md5_context context = CRYPT_MD5Start();
789 for (int i = 0; i < height; ++i)
790 CRYPT_MD5Update(&context, span.subspan(i * stride, usable_bytes_per_row));
Dan Sinclair957480c2017-06-13 15:21:14 -0400791 uint8_t digest[16];
Lei Zhangbf980142019-12-20 01:05:42 +0000792 CRYPT_MD5Finish(&context, digest);
Dan Sinclair957480c2017-06-13 15:21:14 -0400793 return CryptToBase16(digest);
794}
795
Henrique Nakashimadb269572018-01-16 19:02:15 +0000796#ifndef NDEBUG
797// static
798void EmbedderTest::WriteBitmapToPng(FPDF_BITMAP bitmap,
799 const std::string& filename) {
Henrique Nakashimaf956bad2018-08-16 16:41:42 +0000800 BitmapSaver::WriteBitmapToPng(bitmap, filename);
Henrique Nakashimadb269572018-01-16 19:02:15 +0000801}
802#endif
803
thestigbcd3e532016-11-21 13:37:28 -0800804// static
805void EmbedderTest::CompareBitmap(FPDF_BITMAP bitmap,
806 int expected_width,
807 int expected_height,
808 const char* expected_md5sum) {
809 ASSERT_EQ(expected_width, FPDFBitmap_GetWidth(bitmap));
810 ASSERT_EQ(expected_height, FPDFBitmap_GetHeight(bitmap));
Jane Liu28fb7ba2017-08-02 21:45:57 -0400811
812 // The expected stride is calculated using the same formula as in
813 // CFX_DIBitmap::CalculatePitchAndSize(), which sets the bitmap stride.
814 const int expected_stride =
815 (expected_width * GetBitmapBytesPerPixel(bitmap) * 8 + 31) / 32 * 4;
thestigbcd3e532016-11-21 13:37:28 -0800816 ASSERT_EQ(expected_stride, FPDFBitmap_GetStride(bitmap));
817
818 if (!expected_md5sum)
819 return;
820
Henrique Nakashima9fa50362017-11-10 22:40:44 +0000821 EXPECT_EQ(expected_md5sum, HashBitmap(bitmap));
thestigbcd3e532016-11-21 13:37:28 -0800822}
823
Nicolas Pena3ff54002017-07-05 11:55:35 -0400824// static
825int EmbedderTest::WriteBlockCallback(FPDF_FILEWRITE* pFileWrite,
826 const void* data,
827 unsigned long size) {
828 EmbedderTest* pThis = static_cast<EmbedderTest*>(pFileWrite);
Henrique Nakashima7c2e8a32018-06-06 19:17:34 +0000829
Lei Zhang0729be22018-02-05 21:13:51 +0000830 pThis->data_string_.append(static_cast<const char*>(data), size);
Henrique Nakashima7c2e8a32018-06-06 19:17:34 +0000831
832 if (pThis->filestream_.is_open())
833 pThis->filestream_.write(static_cast<const char*>(data), size);
834
Nicolas Pena3ff54002017-07-05 11:55:35 -0400835 return 1;
836}
837
838// static
839int EmbedderTest::GetBlockFromString(void* param,
840 unsigned long pos,
841 unsigned char* buf,
842 unsigned long size) {
843 std::string* new_file = static_cast<std::string*>(param);
Lei Zhangcef91f12019-01-08 21:32:51 +0000844 if (!new_file || pos + size < pos) {
845 NOTREACHED();
Nicolas Pena3ff54002017-07-05 11:55:35 -0400846 return 0;
Lei Zhangcef91f12019-01-08 21:32:51 +0000847 }
Nicolas Pena3ff54002017-07-05 11:55:35 -0400848
Lei Zhangcef91f12019-01-08 21:32:51 +0000849 if (pos + size > new_file->size()) {
850 NOTREACHED();
Nicolas Pena3ff54002017-07-05 11:55:35 -0400851 return 0;
Lei Zhangcef91f12019-01-08 21:32:51 +0000852 }
Nicolas Pena3ff54002017-07-05 11:55:35 -0400853
854 memcpy(buf, new_file->data() + pos, size);
855 return 1;
856}
Lei Zhang75c81712018-02-08 17:22:39 +0000857
Lei Zhang9f72c452018-02-08 21:49:54 +0000858// static
859int EmbedderTest::GetPageNumberForPage(const PageNumberToHandleMap& page_map,
860 FPDF_PAGE page) {
861 for (const auto& it : page_map) {
Lei Zhang75c81712018-02-08 17:22:39 +0000862 if (it.second == page) {
863 int page_number = it.first;
Tom Sepez25f33d02021-01-29 01:58:51 +0000864 DCHECK(page_number >= 0);
Lei Zhang75c81712018-02-08 17:22:39 +0000865 return page_number;
866 }
867 }
868 return -1;
869}
Lei Zhang9f72c452018-02-08 21:49:54 +0000870
871int EmbedderTest::GetPageNumberForLoadedPage(FPDF_PAGE page) const {
872 return GetPageNumberForPage(page_map_, page);
873}
874
875int EmbedderTest::GetPageNumberForSavedPage(FPDF_PAGE page) const {
876 return GetPageNumberForPage(saved_page_map_, page);
877}
Henrique Nakashima7c2e8a32018-06-06 19:17:34 +0000878
Lei Zhang81a799e2019-12-16 17:37:13 +0000879#ifndef NDEBUG
880void EmbedderTest::OpenPDFFileForWrite(const std::string& filename) {
Henrique Nakashima7c2e8a32018-06-06 19:17:34 +0000881 filestream_.open(filename, std::ios_base::binary);
882}
883
884void EmbedderTest::ClosePDFFileForWrite() {
885 filestream_.close();
886}
Lei Zhang81a799e2019-12-16 17:37:13 +0000887#endif