Test top-level Document JS properties.
[pdfium.git] / samples / pdfium_test.cc
1 // Copyright (c) 2010 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 #include <limits.h>
6 #include <stdio.h>
7 #include <stdlib.h>
8 #include <string.h>
9
10 #include <list>
11 #include <sstream>
12 #include <string>
13 #include <utility>
14 #include <vector>
15
16 #include "../fpdfsdk/include/fpdf_dataavail.h"
17 #include "../fpdfsdk/include/fpdf_ext.h"
18 #include "../fpdfsdk/include/fpdfformfill.h"
19 #include "../fpdfsdk/include/fpdftext.h"
20 #include "../fpdfsdk/include/fpdfview.h"
21 #include "../core/include/fxcrt/fx_system.h"
22 #include "v8/include/v8.h"
23 #include "v8/include/libplatform/libplatform.h"
24
25 #ifdef _WIN32
26 #define snprintf _snprintf
27 #define PATH_SEPARATOR '\\'
28 #else
29 #define PATH_SEPARATOR '/'
30 #endif
31
32 enum OutputFormat {
33   OUTPUT_NONE,
34   OUTPUT_PPM,
35 #ifdef _WIN32
36   OUTPUT_BMP,
37   OUTPUT_EMF,
38 #endif
39 };
40
41 struct Options {
42   Options() : output_format(OUTPUT_NONE) { }
43
44   OutputFormat output_format;
45   std::string scale_factor_as_string;
46   std::string exe_path;
47   std::string bin_directory;
48 };
49
50 // Reads the entire contents of a file into a newly malloc'd buffer.
51 static char* GetFileContents(const char* filename, size_t* retlen) {
52   FILE* file = fopen(filename, "rb");
53   if (!file) {
54     fprintf(stderr, "Failed to open: %s\n", filename);
55     return NULL;
56   }
57   (void) fseek(file, 0, SEEK_END);
58   size_t file_length = ftell(file);
59   if (!file_length) {
60     return NULL;
61   }
62   (void) fseek(file, 0, SEEK_SET);
63   char* buffer = (char*) malloc(file_length);
64   if (!buffer) {
65     return NULL;
66   }
67   size_t bytes_read = fread(buffer, 1, file_length, file);
68   (void) fclose(file);
69   if (bytes_read != file_length) {
70     fprintf(stderr, "Failed to read: %s\n", filename);
71     free(buffer);
72     return NULL;
73   }
74   *retlen = bytes_read;
75   return buffer;
76 }
77
78 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
79 // Returns the full path for an external V8 data file based on either
80 // the currect exectuable path or an explicit override.
81 static std::string GetFullPathForSnapshotFile(const Options& options,
82                                               const std::string& filename) {
83   std::string result;
84   if (!options.bin_directory.empty()) {
85     result = options.bin_directory;
86     if (*options.bin_directory.rbegin() != PATH_SEPARATOR) {
87       result += PATH_SEPARATOR;
88     }
89   } else if (!options.exe_path.empty()) {
90     size_t last_separator = options.exe_path.rfind(PATH_SEPARATOR);
91     if (last_separator != std::string::npos)  {
92       result = options.exe_path.substr(0, last_separator + 1);
93     }
94   }
95   result += filename;
96   return result;
97 }
98
99 // Reads an extenal V8 data file from the |options|-indicated location,
100 // returing true on success and false on error.
101 static bool GetExternalData(const Options& options,
102                             const std::string& bin_filename,
103                             v8::StartupData* result_data) {
104   std::string full_path = GetFullPathForSnapshotFile(options, bin_filename);
105   size_t data_length = 0;
106   char* data_buffer = GetFileContents(full_path.c_str(), &data_length);
107   if (!data_buffer) {
108     return false;
109   }
110   result_data->data = const_cast<const char*>(data_buffer);
111   result_data->raw_size = static_cast<int>(data_length);
112   return true;
113 }
114 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
115
116 static void WritePpm(const char* pdf_name, int num, const void* buffer_void,
117                      int stride, int width, int height) {
118   const char* buffer = reinterpret_cast<const char*>(buffer_void);
119
120   if (stride < 0 || width < 0 || height < 0)
121     return;
122   if (height > 0 && width > INT_MAX / height)
123     return;
124   int out_len = width * height;
125   if (out_len > INT_MAX / 3)
126     return;
127   out_len *= 3;
128
129   char filename[256];
130   snprintf(filename, sizeof(filename), "%s.%d.ppm", pdf_name, num);
131   FILE* fp = fopen(filename, "wb");
132   if (!fp)
133     return;
134   fprintf(fp, "P6\n# PDF test render\n%d %d\n255\n", width, height);
135   // Source data is B, G, R, unused.
136   // Dest data is R, G, B.
137   char* result = new char[out_len];
138   if (result) {
139     for (int h = 0; h < height; ++h) {
140       const char* src_line = buffer + (stride * h);
141       char* dest_line = result + (width * h * 3);
142       for (int w = 0; w < width; ++w) {
143         // R
144         dest_line[w * 3] = src_line[(w * 4) + 2];
145         // G
146         dest_line[(w * 3) + 1] = src_line[(w * 4) + 1];
147         // B
148         dest_line[(w * 3) + 2] = src_line[w * 4];
149       }
150     }
151     fwrite(result, out_len, 1, fp);
152     delete [] result;
153   }
154   fclose(fp);
155 }
156
157 #ifdef _WIN32
158 static void WriteBmp(const char* pdf_name, int num, const void* buffer,
159                      int stride, int width, int height) {
160   if (stride < 0 || width < 0 || height < 0)
161     return;
162   if (height > 0 && width > INT_MAX / height)
163     return;
164   int out_len = stride * height;
165   if (out_len > INT_MAX / 3)
166     return;
167
168   char filename[256];
169   snprintf(filename, sizeof(filename), "%s.%d.bmp", pdf_name, num);
170   FILE* fp = fopen(filename, "wb");
171   if (!fp)
172     return;
173
174   BITMAPINFO bmi = {0};
175   bmi.bmiHeader.biSize = sizeof(bmi) - sizeof(RGBQUAD);
176   bmi.bmiHeader.biWidth = width;
177   bmi.bmiHeader.biHeight = -height;  // top-down image
178   bmi.bmiHeader.biPlanes = 1;
179   bmi.bmiHeader.biBitCount = 32;
180   bmi.bmiHeader.biCompression = BI_RGB;
181   bmi.bmiHeader.biSizeImage = 0;
182
183   BITMAPFILEHEADER file_header = {0};
184   file_header.bfType = 0x4d42;
185   file_header.bfSize = sizeof(file_header) + bmi.bmiHeader.biSize + out_len;
186   file_header.bfOffBits = file_header.bfSize - out_len;
187
188   fwrite(&file_header, sizeof(file_header), 1, fp);
189   fwrite(&bmi, bmi.bmiHeader.biSize, 1, fp);
190   fwrite(buffer, out_len, 1, fp);
191   fclose(fp);
192 }
193
194 void WriteEmf(FPDF_PAGE page, const char* pdf_name, int num) {
195   int width = static_cast<int>(FPDF_GetPageWidth(page));
196   int height = static_cast<int>(FPDF_GetPageHeight(page));
197
198   char filename[256];
199   snprintf(filename, sizeof(filename), "%s.%d.emf", pdf_name, num);
200
201   HDC dc = CreateEnhMetaFileA(NULL, filename, NULL, NULL);
202
203   HRGN rgn = CreateRectRgn(0, 0, width, height);
204   SelectClipRgn(dc, rgn);
205   DeleteObject(rgn);
206
207   SelectObject(dc, GetStockObject(NULL_PEN));
208   SelectObject(dc, GetStockObject(WHITE_BRUSH));
209   // If a PS_NULL pen is used, the dimensions of the rectangle are 1 pixel less.
210   Rectangle(dc, 0, 0, width + 1, height + 1);
211
212   FPDF_RenderPage(dc, page, 0, 0, width, height, 0,
213                   FPDF_ANNOT | FPDF_PRINTING | FPDF_NO_CATCH);
214
215   DeleteEnhMetaFile(CloseEnhMetaFile(dc));
216 }
217 #endif
218
219 int ExampleAppAlert(IPDF_JSPLATFORM*, FPDF_WIDESTRING msg, FPDF_WIDESTRING,
220                     int, int) {
221   // Deal with differences between UTF16LE and wchar_t on this platform.
222   size_t characters = 0;
223   while (msg[characters]) {
224     ++characters;
225   }
226   wchar_t* platform_string =
227       (wchar_t*)malloc((characters + 1) * sizeof(wchar_t));
228   for (size_t i = 0; i < characters + 1; ++i) {
229     unsigned char* ptr = (unsigned char*)&msg[i];
230     platform_string[i] = ptr[0] + 256 * ptr[1];
231   }
232   printf("Alert: %ls\n", platform_string);
233   free(platform_string);
234   return 0;
235 }
236
237 void ExampleDocGotoPage(IPDF_JSPLATFORM*, int pageNumber) {
238   printf("Goto Page: %d\n", pageNumber);
239 }
240
241 void ExampleUnsupportedHandler(UNSUPPORT_INFO*, int type) {
242   std::string feature = "Unknown";
243   switch (type) {
244     case FPDF_UNSP_DOC_XFAFORM:
245       feature = "XFA";
246       break;
247     case FPDF_UNSP_DOC_PORTABLECOLLECTION:
248       feature = "Portfolios_Packages";
249       break;
250     case FPDF_UNSP_DOC_ATTACHMENT:
251     case FPDF_UNSP_ANNOT_ATTACHMENT:
252       feature = "Attachment";
253       break;
254     case FPDF_UNSP_DOC_SECURITY:
255       feature = "Rights_Management";
256       break;
257     case FPDF_UNSP_DOC_SHAREDREVIEW:
258       feature = "Shared_Review";
259       break;
260     case FPDF_UNSP_DOC_SHAREDFORM_ACROBAT:
261     case FPDF_UNSP_DOC_SHAREDFORM_FILESYSTEM:
262     case FPDF_UNSP_DOC_SHAREDFORM_EMAIL:
263       feature = "Shared_Form";
264       break;
265     case FPDF_UNSP_ANNOT_3DANNOT:
266       feature = "3D";
267       break;
268     case FPDF_UNSP_ANNOT_MOVIE:
269       feature = "Movie";
270       break;
271     case FPDF_UNSP_ANNOT_SOUND:
272       feature = "Sound";
273       break;
274     case FPDF_UNSP_ANNOT_SCREEN_MEDIA:
275     case FPDF_UNSP_ANNOT_SCREEN_RICHMEDIA:
276       feature = "Screen";
277       break;
278     case FPDF_UNSP_ANNOT_SIG:
279       feature = "Digital_Signature";
280       break;
281   }
282   printf("Unsupported feature: %s.\n", feature.c_str());
283 }
284
285 bool ParseCommandLine(const std::vector<std::string>& args,
286                       Options* options, std::list<std::string>* files) {
287   if (args.empty()) {
288     return false;
289   }
290   options->exe_path = args[0];
291   size_t cur_idx = 1;
292   for (; cur_idx < args.size(); ++cur_idx) {
293     const std::string& cur_arg = args[cur_idx];
294     if (cur_arg == "--ppm") {
295       if (options->output_format != OUTPUT_NONE) {
296         fprintf(stderr, "Duplicate or conflicting --ppm argument\n");
297         return false;
298       }
299       options->output_format = OUTPUT_PPM;
300     }
301 #ifdef _WIN32
302     else if (cur_arg == "--emf") {
303       if (options->output_format != OUTPUT_NONE) {
304         fprintf(stderr, "Duplicate or conflicting --emf argument\n");
305         return false;
306       }
307       options->output_format = OUTPUT_EMF;
308     }
309     else if (cur_arg == "--bmp") {
310       if (options->output_format != OUTPUT_NONE) {
311         fprintf(stderr, "Duplicate or conflicting --bmp argument\n");
312         return false;
313       }
314       options->output_format = OUTPUT_BMP;
315     }
316 #endif  // _WIN32
317 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
318     else if (cur_arg.size() > 10 && cur_arg.compare(0, 10, "--bin-dir=") == 0) {
319       if (!options->bin_directory.empty()) {
320         fprintf(stderr, "Duplicate --bin-dir argument\n");
321         return false;
322       }
323       options->bin_directory = cur_arg.substr(10);
324     }
325 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
326     else if (cur_arg.size() > 8 && cur_arg.compare(0, 8, "--scale=") == 0) {
327       if (!options->scale_factor_as_string.empty()) {
328         fprintf(stderr, "Duplicate --scale argument\n");
329         return false;
330       }
331       options->scale_factor_as_string = cur_arg.substr(8);
332     }
333     else
334       break;
335   }
336   if (cur_idx >= args.size()) {
337     fprintf(stderr, "No input files.\n");
338     return false;
339   }
340   for (size_t i = cur_idx; i < args.size(); i++) {
341     files->push_back(args[i]);
342   }
343   return true;
344 }
345
346 class TestLoader {
347  public:
348   TestLoader(const char* pBuf, size_t len);
349
350   const char* m_pBuf;
351   size_t m_Len;
352 };
353
354 TestLoader::TestLoader(const char* pBuf, size_t len)
355     : m_pBuf(pBuf), m_Len(len) {
356 }
357
358 int Get_Block(void* param, unsigned long pos, unsigned char* pBuf,
359               unsigned long size) {
360   TestLoader* pLoader = (TestLoader*) param;
361   if (pos + size < pos || pos + size > pLoader->m_Len) return 0;
362   memcpy(pBuf, pLoader->m_pBuf + pos, size);
363   return 1;
364 }
365
366 bool Is_Data_Avail(FX_FILEAVAIL* pThis, size_t offset, size_t size) {
367   return true;
368 }
369
370 void Add_Segment(FX_DOWNLOADHINTS* pThis, size_t offset, size_t size) {
371 }
372
373 void RenderPdf(const std::string& name, const char* pBuf, size_t len,
374                const Options& options) {
375   fprintf(stderr, "Rendering PDF file %s.\n", name.c_str());
376
377   IPDF_JSPLATFORM platform_callbacks;
378   memset(&platform_callbacks, '\0', sizeof(platform_callbacks));
379   platform_callbacks.version = 1;
380   platform_callbacks.app_alert = ExampleAppAlert;
381   platform_callbacks.Doc_gotoPage = ExampleDocGotoPage;
382
383   FPDF_FORMFILLINFO form_callbacks;
384   memset(&form_callbacks, '\0', sizeof(form_callbacks));
385   form_callbacks.version = 1;
386   form_callbacks.m_pJsPlatform = &platform_callbacks;
387
388   TestLoader loader(pBuf, len);
389
390   FPDF_FILEACCESS file_access;
391   memset(&file_access, '\0', sizeof(file_access));
392   file_access.m_FileLen = static_cast<unsigned long>(len);
393   file_access.m_GetBlock = Get_Block;
394   file_access.m_Param = &loader;
395
396   FX_FILEAVAIL file_avail;
397   memset(&file_avail, '\0', sizeof(file_avail));
398   file_avail.version = 1;
399   file_avail.IsDataAvail = Is_Data_Avail;
400
401   FX_DOWNLOADHINTS hints;
402   memset(&hints, '\0', sizeof(hints));
403   hints.version = 1;
404   hints.AddSegment = Add_Segment;
405
406   FPDF_DOCUMENT doc;
407   FPDF_AVAIL pdf_avail = FPDFAvail_Create(&file_avail, &file_access);
408
409   (void) FPDFAvail_IsDocAvail(pdf_avail, &hints);
410
411   if (!FPDFAvail_IsLinearized(pdf_avail)) {
412     fprintf(stderr, "Non-linearized path...\n");
413     doc = FPDF_LoadCustomDocument(&file_access, NULL);
414   } else {
415     fprintf(stderr, "Linearized path...\n");
416     doc = FPDFAvail_GetDocument(pdf_avail, NULL);
417   }
418
419   (void) FPDF_GetDocPermissions(doc);
420   (void) FPDFAvail_IsFormAvail(pdf_avail, &hints);
421
422   FPDF_FORMHANDLE form = FPDFDOC_InitFormFillEnvironment(doc, &form_callbacks);
423   FPDF_SetFormFieldHighlightColor(form, 0, 0xFFE4DD);
424   FPDF_SetFormFieldHighlightAlpha(form, 100);
425
426   int first_page = FPDFAvail_GetFirstPageNum(doc);
427   (void) FPDFAvail_IsPageAvail(pdf_avail, first_page, &hints);
428
429   int page_count = FPDF_GetPageCount(doc);
430   for (int i = 0; i < page_count; ++i) {
431     (void) FPDFAvail_IsPageAvail(pdf_avail, i, &hints);
432   }
433
434   FORM_DoDocumentJSAction(form);
435   FORM_DoDocumentOpenAction(form);
436
437   size_t rendered_pages = 0;
438   size_t bad_pages = 0;
439   for (int i = 0; i < page_count; ++i) {
440     FPDF_PAGE page = FPDF_LoadPage(doc, i);
441     if (!page) {
442         bad_pages ++;
443         continue;
444     }
445     FPDF_TEXTPAGE text_page = FPDFText_LoadPage(page);
446     FORM_OnAfterLoadPage(page, form);
447     FORM_DoPageAAction(page, form, FPDFPAGE_AACTION_OPEN);
448
449     int width = static_cast<int>(FPDF_GetPageWidth(page));
450     int height = static_cast<int>(FPDF_GetPageHeight(page));
451     if (!options.scale_factor_as_string.empty()) {
452       double scale = 1.0;
453       std::stringstream(options.scale_factor_as_string) >> scale;
454       width *= scale;
455       height *= scale;
456     }
457
458     FPDF_BITMAP bitmap = FPDFBitmap_Create(width, height, 0);
459     FPDFBitmap_FillRect(bitmap, 0, 0, width, height, 0xFFFFFFFF);
460     FPDF_RenderPageBitmap(bitmap, page, 0, 0, width, height, 0, 0);
461     rendered_pages ++;
462
463     FPDF_FFLDraw(form, bitmap, page, 0, 0, width, height, 0, 0);
464     int stride = FPDFBitmap_GetStride(bitmap);
465     const char* buffer =
466         reinterpret_cast<const char*>(FPDFBitmap_GetBuffer(bitmap));
467
468     switch (options.output_format) {
469 #ifdef _WIN32
470       case OUTPUT_BMP:
471         WriteBmp(name.c_str(), i, buffer, stride, width, height);
472         break;
473
474       case OUTPUT_EMF:
475         WriteEmf(page, name.c_str(), i);
476         break;
477 #endif
478       case OUTPUT_PPM:
479         WritePpm(name.c_str(), i, buffer, stride, width, height);
480         break;
481       default:
482         break;
483     }
484
485     FPDFBitmap_Destroy(bitmap);
486
487     FORM_DoPageAAction(page, form, FPDFPAGE_AACTION_CLOSE);
488     FORM_OnBeforeClosePage(page, form);
489     FPDFText_ClosePage(text_page);
490     FPDF_ClosePage(page);
491   }
492
493   FORM_DoDocumentAAction(form, FPDFDOC_AACTION_WC);
494   FPDFDOC_ExitFormFillEnvironment(form);
495   FPDF_CloseDocument(doc);
496   FPDFAvail_Destroy(pdf_avail);
497
498   fprintf(stderr, "Rendered %" PRIuS " pages.\n", rendered_pages);
499   fprintf(stderr, "Skipped %" PRIuS " bad pages.\n", bad_pages);
500 }
501
502 static const char usage_string[] =
503     "Usage: pdfium_test [OPTION] [FILE]...\n"
504     "  --bin-dir=<path> - override path to v8 external data\n"
505     "  --scale=<number> - scale output size by number (e.g. 0.5)\n"
506 #ifdef _WIN32
507     "  --bmp - write page images <pdf-name>.<page-number>.bmp\n"
508     "  --emf - write page meta files <pdf-name>.<page-number>.emf\n"
509 #endif
510     "  --ppm - write page images <pdf-name>.<page-number>.ppm\n";
511
512 int main(int argc, const char* argv[]) {
513   std::vector<std::string> args(argv, argv + argc);
514   Options options;
515   std::list<std::string> files;
516   if (!ParseCommandLine(args, &options, &files)) {
517     fprintf(stderr, "%s", usage_string);
518     return 1;
519   }
520
521   v8::V8::InitializeICU();
522   v8::Platform* platform = v8::platform::CreateDefaultPlatform();
523   v8::V8::InitializePlatform(platform);
524   v8::V8::Initialize();
525
526 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
527   v8::StartupData natives;
528   v8::StartupData snapshot;
529   if (!GetExternalData(options, "natives_blob.bin", &natives) ||
530       !GetExternalData(options, "snapshot_blob.bin", &snapshot)) {
531     return 1;
532   }
533   v8::V8::SetNativesDataBlob(&natives);
534   v8::V8::SetSnapshotDataBlob(&snapshot);
535 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
536
537   FPDF_InitLibrary();
538
539   UNSUPPORT_INFO unsuppored_info;
540   memset(&unsuppored_info, '\0', sizeof(unsuppored_info));
541   unsuppored_info.version = 1;
542   unsuppored_info.FSDK_UnSupport_Handler = ExampleUnsupportedHandler;
543
544   FSDK_SetUnSpObjProcessHandler(&unsuppored_info);
545
546   while (!files.empty()) {
547     std::string filename = files.front();
548     files.pop_front();
549     size_t file_length = 0;
550     char* file_contents = GetFileContents(filename.c_str(), &file_length);
551     if (!file_contents)
552       continue;
553     RenderPdf(filename, file_contents, file_length, options);
554     free(file_contents);
555   }
556
557   FPDF_DestroyLibrary();
558   v8::V8::ShutdownPlatform();
559   delete platform;
560
561   return 0;
562 }