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