Cherry-pick to XFA: Fix a clang warning about a dangling else.
[pdfium.git] / testing / embedder_test.cpp
1 // Copyright (c) 2015 PDFium 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 #include "embedder_test.h"
6
7 #include <limits.h>
8 #include <stdio.h>
9 #include <stdlib.h>
10 #include <string.h>
11
12 #include <list>
13 #include <string>
14 #include <utility>
15 #include <vector>
16
17 #include "../public/fpdf_text.h"
18 #include "../public/fpdfview.h"
19 #include "testing/gmock/include/gmock/gmock.h"
20 #include "v8/include/libplatform/libplatform.h"
21 #include "v8/include/v8.h"
22
23 #ifdef _WIN32
24 #define snprintf _snprintf
25 #define PATH_SEPARATOR '\\'
26 #else
27 #define PATH_SEPARATOR '/'
28 #endif
29
30 namespace {
31
32 const char* g_exe_path_ = nullptr;
33
34 // Reads the entire contents of a file into a newly malloc'd buffer.
35 static char* GetFileContents(const char* filename, size_t* retlen) {
36   FILE* file = fopen(filename, "rb");
37   if (!file) {
38     fprintf(stderr, "Failed to open: %s\n", filename);
39     return nullptr;
40   }
41   (void) fseek(file, 0, SEEK_END);
42   size_t file_length = ftell(file);
43   if (!file_length) {
44     return nullptr;
45   }
46   (void) fseek(file, 0, SEEK_SET);
47   char* buffer = (char*) malloc(file_length);
48   if (!buffer) {
49     return nullptr;
50   }
51   size_t bytes_read = fread(buffer, 1, file_length, file);
52   (void) fclose(file);
53   if (bytes_read != file_length) {
54     fprintf(stderr, "Failed to read: %s\n", filename);
55     free(buffer);
56     return nullptr;
57   }
58   *retlen = bytes_read;
59   return buffer;
60 }
61
62 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
63 // Returns the full path for an external V8 data file based on either
64 // the currect exectuable path or an explicit override.
65 static std::string GetFullPathForSnapshotFile(const std::string& exe_path,
66                                               const std::string& filename) {
67   std::string result;
68   if (!exe_path.empty()) {
69     size_t last_separator = exe_path.rfind(PATH_SEPARATOR);
70     if (last_separator != std::string::npos)  {
71       result = exe_path.substr(0, last_separator + 1);
72     }
73   }
74   result += filename;
75   return result;
76 }
77
78 // Reads an extenal V8 data file from the |options|-indicated location,
79 // returing true on success and false on error.
80 static bool GetExternalData(const std::string& exe_path,
81                             const std::string& filename,
82                             v8::StartupData* result_data) {
83   std::string full_path = GetFullPathForSnapshotFile(exe_path, filename);
84   size_t data_length = 0;
85   char* data_buffer = GetFileContents(full_path.c_str(), &data_length);
86   if (!data_buffer) {
87     return false;
88   }
89   result_data->data = const_cast<const char*>(data_buffer);
90   result_data->raw_size = data_length;
91   return true;
92 }
93 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
94
95 }  // namespace
96
97 class TestLoader {
98  public:
99   TestLoader(const char* pBuf, size_t len);
100
101   const char* m_pBuf;
102   size_t m_Len;
103 };
104
105 TestLoader::TestLoader(const char* pBuf, size_t len)
106     : m_pBuf(pBuf), m_Len(len) {
107 }
108
109 int Get_Block(void* param, unsigned long pos, unsigned char* pBuf,
110               unsigned long size) {
111   TestLoader* pLoader = (TestLoader*) param;
112   if (pos + size < pos || pos + size > pLoader->m_Len) return 0;
113   memcpy(pBuf, pLoader->m_pBuf + pos, size);
114   return 1;
115 }
116
117 FPDF_BOOL Is_Data_Avail(FX_FILEAVAIL* pThis, size_t offset, size_t size) {
118   return true;
119 }
120
121 void Add_Segment(FX_DOWNLOADHINTS* pThis, size_t offset, size_t size) {
122 }
123
124 EmbedderTest::EmbedderTest() :
125       document_(nullptr),
126       form_handle_(nullptr),
127       avail_(nullptr),
128       loader_(nullptr),
129       file_length_(0),
130       file_contents_(nullptr) {
131   memset(&hints_, 0, sizeof(hints_));
132   memset(&file_access_, 0, sizeof(file_access_));
133   memset(&file_avail_, 0, sizeof(file_avail_));
134   default_delegate_ = new EmbedderTest::Delegate();
135   delegate_ = default_delegate_;
136 }
137
138 EmbedderTest::~EmbedderTest() {
139   delete default_delegate_;
140 }
141
142 void EmbedderTest::SetUp() {
143     v8::V8::InitializeICU();
144
145     platform_ = v8::platform::CreateDefaultPlatform();
146     v8::V8::InitializePlatform(platform_);
147     v8::V8::Initialize();
148
149     // By enabling predictable mode, V8 won't post any background tasks.
150     const char predictable_flag[] = "--predictable";
151     v8::V8::SetFlagsFromString(predictable_flag,
152                                static_cast<int>(strlen(predictable_flag)));
153
154 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
155     ASSERT_TRUE(GetExternalData(g_exe_path_, "natives_blob.bin", &natives_));
156     ASSERT_TRUE(GetExternalData(g_exe_path_, "snapshot_blob.bin", &snapshot_));
157     v8::V8::SetNativesDataBlob(&natives_);
158     v8::V8::SetSnapshotDataBlob(&snapshot_);
159 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
160
161     FPDF_InitLibrary();
162
163     UNSUPPORT_INFO* info = static_cast<UNSUPPORT_INFO*>(this);
164     memset(info, 0, sizeof(UNSUPPORT_INFO));
165     info->version = 1;
166     info->FSDK_UnSupport_Handler = UnsupportedHandlerTrampoline;
167     FSDK_SetUnSpObjProcessHandler(info);
168   }
169
170 void EmbedderTest::TearDown() {
171   if (document_) {
172     FORM_DoDocumentAAction(form_handle_, FPDFDOC_AACTION_WC);
173     FPDF_CloseDocument(document_);
174     FPDFDOC_ExitFormFillEnvironment(form_handle_);
175   }
176   FPDFAvail_Destroy(avail_);
177   FPDF_DestroyLibrary();
178   v8::V8::ShutdownPlatform();
179   delete platform_;
180   delete loader_;
181   free(file_contents_);
182 }
183
184 bool EmbedderTest::OpenDocument(const std::string& filename) {
185   file_contents_ = GetFileContents(filename.c_str(), &file_length_);
186   if (!file_contents_) {
187     return false;
188   }
189
190   loader_ = new TestLoader(file_contents_, file_length_);
191   file_access_.m_FileLen = static_cast<unsigned long>(file_length_);
192   file_access_.m_GetBlock = Get_Block;
193   file_access_.m_Param = loader_;
194
195   file_avail_.version = 1;
196   file_avail_.IsDataAvail = Is_Data_Avail;
197
198   hints_.version = 1;
199   hints_.AddSegment = Add_Segment;
200
201   avail_ = FPDFAvail_Create(&file_avail_, &file_access_);
202   (void) FPDFAvail_IsDocAvail(avail_, &hints_);
203
204   if (!FPDFAvail_IsLinearized(avail_)) {
205     document_ = FPDF_LoadCustomDocument(&file_access_, nullptr);
206   } else {
207     document_ = FPDFAvail_GetDocument(avail_, nullptr);
208   }
209   if (!document_) {
210     return false;
211   }
212   int docType = DOCTYPE_PDF;
213   if (FPDF_HasXFAField(document_, &docType))
214   {
215     if (docType != DOCTYPE_PDF)
216       (void) FPDF_LoadXFA(document_);
217   }
218   (void) FPDF_GetDocPermissions(document_);
219   (void) FPDFAvail_IsFormAvail(avail_, &hints_);
220
221   IPDF_JSPLATFORM* platform = static_cast<IPDF_JSPLATFORM*>(this);
222   memset(platform, 0, sizeof(IPDF_JSPLATFORM));
223   platform->version = 1;
224   platform->app_alert = AlertTrampoline;
225
226   FPDF_FORMFILLINFO* formfillinfo = static_cast<FPDF_FORMFILLINFO*>(this);
227   memset(formfillinfo, 0, sizeof(FPDF_FORMFILLINFO));
228   formfillinfo->version = 1;
229   formfillinfo->FFI_SetTimer = SetTimerTrampoline;
230   formfillinfo->FFI_KillTimer = KillTimerTrampoline;
231   formfillinfo->m_pJsPlatform = platform;
232
233   form_handle_ = FPDFDOC_InitFormFillEnvironment(document_, formfillinfo);
234   FPDF_SetFormFieldHighlightColor(form_handle_, 0, 0xFFE4DD);
235   FPDF_SetFormFieldHighlightAlpha(form_handle_, 100);
236
237   return true;
238 }
239
240 void EmbedderTest::DoOpenActions() {
241   FORM_DoDocumentJSAction(form_handle_);
242   FORM_DoDocumentOpenAction(form_handle_);
243 }
244
245 int EmbedderTest::GetFirstPageNum() {
246   int first_page = FPDFAvail_GetFirstPageNum(document_);
247   (void) FPDFAvail_IsPageAvail(avail_, first_page, &hints_);
248   return first_page;
249 }
250
251 int EmbedderTest::GetPageCount() {
252   int page_count = FPDF_GetPageCount(document_);
253   for (int i = 0; i < page_count; ++i) {
254     (void) FPDFAvail_IsPageAvail(avail_, i, &hints_);
255   }
256   return page_count;
257 }
258
259 FPDF_PAGE EmbedderTest::LoadPage(int page_number) {
260   FPDF_PAGE page = FPDF_LoadPage(document_, page_number);
261   if (!page) {
262     return nullptr;
263   }
264   FORM_OnAfterLoadPage(page, form_handle_);
265   FORM_DoPageAAction(page, form_handle_, FPDFPAGE_AACTION_OPEN);
266   return page;
267 }
268
269 FPDF_BITMAP EmbedderTest::RenderPage(FPDF_PAGE page) {
270   int width = static_cast<int>(FPDF_GetPageWidth(page));
271   int height = static_cast<int>(FPDF_GetPageHeight(page));
272   FPDF_BITMAP bitmap = FPDFBitmap_Create(width, height, 0);
273   FPDFBitmap_FillRect(bitmap, 0, 0, width, height, 0xFFFFFFFF);
274   FPDF_RenderPageBitmap(bitmap, page, 0, 0, width, height, 0, 0);
275   FPDF_FFLDraw(form_handle_, bitmap, page, 0, 0, width, height, 0, 0);
276   return bitmap;
277 }
278
279 void EmbedderTest::UnloadPage(FPDF_PAGE page) {
280   FORM_DoPageAAction(page, form_handle_, FPDFPAGE_AACTION_CLOSE);
281   FORM_OnBeforeClosePage(page, form_handle_);
282   FPDF_ClosePage(page);
283 }
284
285 // static
286 void EmbedderTest::UnsupportedHandlerTrampoline(UNSUPPORT_INFO* info,
287                                                 int type) {
288   EmbedderTest* test = static_cast<EmbedderTest*>(info);
289   test->delegate_->UnsupportedHandler(type);
290 }
291
292 // static
293 int EmbedderTest::AlertTrampoline(IPDF_JSPLATFORM* platform,
294                                   FPDF_WIDESTRING message,
295                                   FPDF_WIDESTRING title,
296                                   int type,
297                                   int icon) {
298   EmbedderTest* test = static_cast<EmbedderTest*>(platform);
299   return test->delegate_->Alert(message, title, type, icon);
300 }
301
302 // static
303 int EmbedderTest::SetTimerTrampoline(FPDF_FORMFILLINFO* info,
304                                      int msecs, TimerCallback fn) {
305   EmbedderTest* test = static_cast<EmbedderTest*>(info);
306   return test->delegate_->SetTimer(msecs, fn);
307 }
308
309 // static
310 void EmbedderTest::KillTimerTrampoline(FPDF_FORMFILLINFO* info, int id) {
311   EmbedderTest* test = static_cast<EmbedderTest*>(info);
312   return test->delegate_->KillTimer(id);
313 }
314
315 // Can't use gtest-provided main since we need to stash the path to the
316 // executable in order to find the external V8 binary data files.
317 int main(int argc, char** argv) {
318   g_exe_path_ = argv[0];
319   testing::InitGoogleTest(&argc, argv);
320   testing::InitGoogleMock(&argc, argv);
321   return RUN_ALL_TESTS();
322 }