Add pdf layer code for PDFium XFA module

pdf/pdfium/pdfium_engine.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "pdf/pdfium/pdfium_engine.h"
 
 #include <math.h>
 
 #include "base/json/json_writer.h"
 #include "base/logging.h"
@@ skipping 579 matching lines @@
   file_availability_.loader = &doc_loader_;
 
   download_hints_.version = 1;
   download_hints_.AddSegment = &AddSegment;
   download_hints_.loader = &doc_loader_;
 
   // Initialize FPDF_FORMFILLINFO member variables.  Deriving from this struct
   // allows the static callbacks to be able to cast the FPDF_FORMFILLINFO in
   // callbacks to ourself instead of maintaining a map of them to
   // PDFiumEngine.
   FPDF_FORMFILLINFO::version = 1;

[Tom Sepez, 2014/11/06 17:45:45]

New fields are added to this structure, but the version stayed unchanged.  This
seems wrong; the version should be bumped (to 2) and checked at some point in
the pdfium library.  We ought to prevent a mismatch between the chrome side and
the pdfium side, since it might call into arbitrary memory.

[Bo Xu, 2014/11/06 18:52:05]

Since we are branching out xfa, the version in xfa branch should be changed to
2. So shall I add a #ifdef PDF_USE_XFA to determine if we want to set version to
1 or 2 here?

   FPDF_FORMFILLINFO::m_pJsPlatform = this;

[Tom Sepez, 2014/11/06 18:10:05]

Note that in going from the pre-xfa version of struct to the xfa version of the
struct in fpdfsdk/include/fpdfformfill.hfpdfsdk/include/fpdfformfill.h, 
          IPDF_JSPLATFORM*        m_pJsPlatform;  
had its offset displaced by the new methods added above it.  This should be
moved back to its original offset if you want to make it simple for a v1 library
to run against a v2 client.

[Bo Xu, 2014/11/06 18:52:05]

If I understand correctly, I should move 
IPDF_JSPLATFORM*	m_pJsPlatform;
in the middle of the struct definition where it was? I will make that change in
xfa branch.

   FPDF_FORMFILLINFO::Release = NULL;
   FPDF_FORMFILLINFO::FFI_Invalidate = Form_Invalidate;
   FPDF_FORMFILLINFO::FFI_OutputSelectedRect = Form_OutputSelectedRect;
   FPDF_FORMFILLINFO::FFI_SetCursor = Form_SetCursor;
   FPDF_FORMFILLINFO::FFI_SetTimer = Form_SetTimer;
   FPDF_FORMFILLINFO::FFI_KillTimer = Form_KillTimer;
   FPDF_FORMFILLINFO::FFI_GetLocalTime = Form_GetLocalTime;
   FPDF_FORMFILLINFO::FFI_OnChange = Form_OnChange;
   FPDF_FORMFILLINFO::FFI_GetPage = Form_GetPage;
   FPDF_FORMFILLINFO::FFI_GetCurrentPage = Form_GetCurrentPage;
   FPDF_FORMFILLINFO::FFI_GetRotation = Form_GetRotation;
   FPDF_FORMFILLINFO::FFI_ExecuteNamedAction = Form_ExecuteNamedAction;
   FPDF_FORMFILLINFO::FFI_SetTextFieldFocus = Form_SetTextFieldFocus;
   FPDF_FORMFILLINFO::FFI_DoURIAction = Form_DoURIAction;
   FPDF_FORMFILLINFO::FFI_DoGoToAction = Form_DoGoToAction;
-
+#ifdef PDF_USE_XFA
+  FPDF_FORMFILLINFO::FFI_EmailTo = Form_EmailTo;
+  FPDF_FORMFILLINFO::FFI_DisplayCaret = Form_DisplayCaret;
+  FPDF_FORMFILLINFO::FFI_SetCurrentPage = Form_SetCurrentPage;
+  FPDF_FORMFILLINFO::FFI_GetCurrentPageIndex = Form_GetCurrentPageIndex;
+  FPDF_FORMFILLINFO::FFI_GetPageViewRect = Form_GetPageViewRect;
+  FPDF_FORMFILLINFO::FFI_GetPlatform = Form_GetPlatform;
+  FPDF_FORMFILLINFO::FFI_PopupMenu = Form_PopupMenu;
+  FPDF_FORMFILLINFO::FFI_PostRequestURL = Form_PostRequestURL;
+  FPDF_FORMFILLINFO::FFI_PutRequestURL = Form_PutRequestURL;
+  FPDF_FORMFILLINFO::FFI_UploadTo = Form_UploadTo;
+  FPDF_FORMFILLINFO::FFI_DownloadFromURL = Form_DownloadFromURL;
+  FPDF_FORMFILLINFO::FFI_OpenFile = Form_OpenFile;
+  FPDF_FORMFILLINFO::FFI_GotoURL = Form_GotoURL;
+  FPDF_FORMFILLINFO::FFI_GetLanguage = Form_GetLanguage;
+#endif  // PDF_USE_XFA
   IPDF_JSPLATFORM::version = 1;
   IPDF_JSPLATFORM::app_alert = Form_Alert;
   IPDF_JSPLATFORM::app_beep = Form_Beep;
   IPDF_JSPLATFORM::app_response = Form_Response;
   IPDF_JSPLATFORM::Doc_getFilePath = Form_GetFilePath;
   IPDF_JSPLATFORM::Doc_mail = Form_Mail;
   IPDF_JSPLATFORM::Doc_print = Form_Print;
   IPDF_JSPLATFORM::Doc_submitForm = Form_SubmitForm;
   IPDF_JSPLATFORM::Doc_gotoPage = Form_GotoPage;
   IPDF_JSPLATFORM::Field_browse = Form_Browse;
 
   IFSDK_PAUSE::version = 1;
   IFSDK_PAUSE::user = NULL;
   IFSDK_PAUSE::NeedToPauseNow = Pause_NeedToPauseNow;
 }
 
 PDFiumEngine::~PDFiumEngine() {
   for (size_t i = 0; i < pages_.size(); ++i)
     pages_[i]->Unload();
 
   if (doc_) {
     if (form_) {
       FORM_DoDocumentAAction(form_, FPDFDOC_AACTION_WC);
+    }
+    FPDF_CloseDocument(doc_);
+    if (form_) {
       FPDFDOC_ExitFormFillEnviroument(form_);
     }
-    FPDF_CloseDocument(doc_);
   }
 
   if (fpdf_availability_)
     FPDFAvail_Destroy(fpdf_availability_);
 
   STLDeleteElements(&pages_);
 }
 
+#ifdef PDF_USE_XFA
+
+//  This is just for testing, needs to be removed later
+#if defined(WIN32)
+#define XFA_TESTFILE(filename) "E:/"#filename
+#else
+#define XFA_TESTFILE(filename) "/home/"#filename
+#endif
+
+struct FPDF_FILE {
+  FPDF_FILEHANDLER fileHandler;

[Lei Zhang, 2014/11/06 19:15:29]

nit: file_handler

+  FILE* file;
+};
+
+void Sample_Release(FPDF_LPVOID cilent_data) {

[Lei Zhang, 2014/11/06 19:15:30]

cilent -> client

+  if (!cilent_data)
+    return;
+  FPDF_FILE* file_wrapper = (FPDF_FILE*)cilent_data;
+  fclose(file_wrapper->file);
+  delete file_wrapper;
+}
+
+FPDF_DWORD Sample_GetSize(FPDF_LPVOID cilent_data) {
+  if (!cilent_data)
+    return 0;
+  FPDF_FILE* file_wrapper = (FPDF_FILE*)cilent_data;
+  long cur_pos = ftell(file_wrapper->file);

[Lei Zhang, 2014/11/06 19:15:30]

ftell() and fseek() can fail and return -1

+  fseek(file_wrapper->file, 0, SEEK_END);
+  long size = ftell(file_wrapper->file);
+  fseek(file_wrapper->file, cur_pos, SEEK_SET);
+  return (FPDF_DWORD)size;
+}
+
+FPDF_RESULT Sample_ReadBlock(FPDF_LPVOID cilent_data,
+                             FPDF_DWORD offset,
+                             FPDF_LPVOID buffer,
+                             FPDF_DWORD size) {
+  if (!cilent_data)
+    return -1;
+  FPDF_FILE* file_wrapper = (FPDF_FILE*)cilent_data;
+  fseek(file_wrapper->file, (long)offset, SEEK_SET);
+  size_t read_size = fread(buffer, 1, size, file_wrapper->file);
+  return read_size == size ? 0 : -1;
+}
+
+FPDF_RESULT Sample_WriteBlock(FPDF_LPVOID cilent_data,
+                              FPDF_DWORD offset,
+                              FPDF_LPCVOID buffer,
+                              FPDF_DWORD size) {
+  if (!cilent_data)
+    return -1;
+  FPDF_FILE* file_wrapper = (FPDF_FILE*)cilent_data;
+  fseek(file_wrapper->file, (long)offset, SEEK_SET);
+  // Write data
+  size_t write_size = fwrite(buffer, 1, size, file_wrapper->file);
+  return write_size == size ? 0 : -1;
+}
+
+FPDF_RESULT Sample_Flush(FPDF_LPVOID cilent_data) {
+  if (!cilent_data)
+    return -1;
+  // Flush file
+  fflush(((FPDF_FILE*)cilent_data)->file);
+  return 0;
+}
+
+FPDF_RESULT Sample_Truncate(FPDF_LPVOID cilent_data, FPDF_DWORD size) {
+  return 0;
+}
+
+void PDFiumEngine::Form_EmailTo(FPDF_FORMFILLINFO* param,
+                                FPDF_FILEHANDLER* file_handler,
+                                FPDF_WIDESTRING to,
+                                FPDF_WIDESTRING subject,
+                                FPDF_WIDESTRING cc,
+                                FPDF_WIDESTRING bcc,
+                                FPDF_WIDESTRING message) {
+  std::string to_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(to));
+  std::string subject_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(subject));
+  std::string cc_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(cc));
+  std::string bcc_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(bcc));
+  std::string message_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(message));
+
+  PDFiumEngine* engine = static_cast<PDFiumEngine*>(param);
+  engine->client_->Email(to_str, cc_str, bcc_str, subject_str, message_str);
+}
+
+void PDFiumEngine::Form_DisplayCaret(FPDF_FORMFILLINFO* param,
+                                     FPDF_PAGE page,
+                                     FPDF_BOOL visible,
+                                     double left,
+                                     double top,
+                                     double right,
+                                     double bottom) {
+  PDFiumEngine* engine = static_cast<PDFiumEngine*>(param);
+  engine->client_->UpdateCursor(PP_CURSORTYPE_IBEAM);
+  std::vector<pp::Rect> tickmarks;
+  pp::Rect rect(left, top, right, bottom);
+  tickmarks.push_back(rect);
+  engine->client_->UpdateTickMarks(tickmarks);
+}
+
+void PDFiumEngine::Form_SetCurrentPage(FPDF_FORMFILLINFO* param,
+                                       FPDF_DOCUMENT document,
+                                       int page) {
+  PDFiumEngine* engine = static_cast<PDFiumEngine*>(param);
+  pp::Rect page_view_rect = engine->GetPageContentsRect(page);
+  engine->ScrolledToYPosition(page_view_rect.height());
+  pp::Point pos(1, page_view_rect.height());
+  engine->SetScrollPosition(pos);
+}
+
+int PDFiumEngine::Form_GetCurrentPageIndex(FPDF_FORMFILLINFO* param,
+                                           FPDF_DOCUMENT document) {
+  int page_index = -1;

[Lei Zhang, 2014/11/06 19:15:29]

you don't need this variable, just return the GetMostVisiblePage() return value.

+  PDFiumEngine* engine = static_cast<PDFiumEngine*>(param);
+  page_index = engine->GetMostVisiblePage();
+  return page_index;
+}
+
+void PDFiumEngine::Form_GetPageViewRect(FPDF_FORMFILLINFO* param,
+                                        FPDF_PAGE page,
+                                        double* left,
+                                        double* top,
+                                        double* right,
+                                        double* bottom) {
+  PDFiumEngine* engine = static_cast<PDFiumEngine*>(param);
+  int page_index = engine->GetMostVisiblePage();
+  pp::Rect page_view_rect = engine->GetPageContentsRect(page_index);
+
+  *left = page_view_rect.x();
+  *right = page_view_rect.width() + page_view_rect.x();

[Lei Zhang, 2014/11/06 19:15:29]

pp::Rect has right() and bottom() methods, but no left() / top()

+  *top = page_view_rect.y();
+  *bottom = page_view_rect.height();
+
+  std::string javascript = "alert(\"PageViewRect:"

[Lei Zhang, 2014/11/06 19:15:29]

another unused variable, more below

+      + base::DoubleToString(*left) + ","
+      + base::DoubleToString(*right) + ","
+      + base::DoubleToString(*top) + ","
+      + base::DoubleToString(*bottom) + ","
+      + "\")";
+}
+
+int PDFiumEngine::Form_GetPlatform(FPDF_FORMFILLINFO* param,
+                                   void* platform,
+                                   int length) {
+  int platform_flag = -1;
+
+#if defined(WIN32)
+  platform_flag = 0;
+#elif defined(__linux__)
+  platform_flag = 1;
+#else
+  platform_flag = 2;
+#endif
+
+  std::string javascript = "alert(\"Platform:"
+      + base::DoubleToString(platform_flag)
+      + "\")";
+
+  return 3;

[Lei Zhang, 2014/11/06 19:15:30]

why doesn't this return |platform_flag| ?

+}
+
+FPDF_BOOL PDFiumEngine::Form_PopupMenu(FPDF_FORMFILLINFO* param,
+                                       FPDF_PAGE page,
+                                       FPDF_WIDGET widget,
+                                       int menu_flag,
+                                       float x,
+                                       float y) {
+  return false;
+}
+
+FPDF_BOOL PDFiumEngine::Form_PostRequestURL(FPDF_FORMFILLINFO* param,
+                                            FPDF_WIDESTRING url,
+                                            FPDF_WIDESTRING data,
+                                            FPDF_WIDESTRING content_type,
+                                            FPDF_WIDESTRING encode,
+                                            FPDF_WIDESTRING header,
+                                            FPDF_BSTR* response) {
+  std::string url_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+  std::string data_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(data));
+  std::string content_type_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(content_type));
+  std::string encode_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(encode));
+  std::string header_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(header));
+
+  std::string javascript = "alert(\"Post:"
+      + url_str + "," + data_str + "," + content_type_str + ","
+      + encode_str + "," + header_str
+      + "\")";
+  return true;
+}
+
+FPDF_BOOL PDFiumEngine::Form_PutRequestURL(FPDF_FORMFILLINFO* param,
+                                           FPDF_WIDESTRING url,
+                                           FPDF_WIDESTRING data,
+                                           FPDF_WIDESTRING encode) {
+  std::string url_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+  std::string data_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(data));
+  std::string encode_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(encode));
+
+  std::string javascript = "alert(\"Put:"
+      + url_str + "," + data_str + "," + encode_str
+      + "\")";
+
+  return true;
+}
+
+void PDFiumEngine::Form_UploadTo(FPDF_FORMFILLINFO* param,
+                                 FPDF_FILEHANDLER* file_handle,
+                                 int file_flag,
+                                 FPDF_WIDESTRING dest) {
+  std::string to_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(dest));
+  // TODO: needs the full implementation of form uploading
+}
+
+FPDF_LPFILEHANDLER PDFiumEngine::Form_DownloadFromURL(FPDF_FORMFILLINFO* param,
+                                                      FPDF_WIDESTRING url) {
+  std::string url_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+
+  // Now should get data from url.
+  // For testing purpose, use data read from file
+  // TODO: needs the full implementation here
+  FILE* file = fopen(XFA_TESTFILE("downloadtest.tem"), "w");
+
+  FPDF_FILE* file_wrapper = new FPDF_FILE;
+  file_wrapper->file = file;
+  file_wrapper->fileHandler.clientData = file_wrapper;
+  file_wrapper->fileHandler.Flush = Sample_Flush;
+  file_wrapper->fileHandler.GetSize = Sample_GetSize;
+  file_wrapper->fileHandler.ReadBlock = Sample_ReadBlock;
+  file_wrapper->fileHandler.Release = Sample_Release;
+  file_wrapper->fileHandler.Truncate = Sample_Truncate;
+  file_wrapper->fileHandler.WriteBlock = Sample_WriteBlock;
+
+  return &file_wrapper->fileHandler;
+}
+
+FPDF_FILEHANDLER* PDFiumEngine::Form_OpenFile(FPDF_FORMFILLINFO* param,
+                                              int file_flag,
+                                              FPDF_WIDESTRING url,
+                                              const char* mode) {
+  std::string url_str = "NULL";
+  if (url != NULL) {
+    url_str =
+        base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+  }
+  if (strncmp(mode, "wb", 2) == 0) {
+    FILE* file = fopen(XFA_TESTFILE("tem.txt"), mode);
+    FPDF_FILE* file_wrapper = new FPDF_FILE;
+    file_wrapper->file = file;
+    file_wrapper->fileHandler.clientData = file_wrapper;
+    file_wrapper->fileHandler.Flush = Sample_Flush;
+    file_wrapper->fileHandler.GetSize = Sample_GetSize;
+    file_wrapper->fileHandler.ReadBlock = Sample_ReadBlock;
+    file_wrapper->fileHandler.Release = Sample_Release;
+    file_wrapper->fileHandler.Truncate = Sample_Truncate;
+    file_wrapper->fileHandler.WriteBlock = Sample_WriteBlock;
+    return &file_wrapper->fileHandler;
+  } else {

[Lei Zhang, 2014/11/06 19:15:30]

you don't need the else block since you always return in the if block.

+    url_str = base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+  }
+  return NULL;
+}
+
+void PDFiumEngine::Form_GotoURL(FPDF_FORMFILLINFO* param,
+                                FPDF_DOCUMENT document,
+                                FPDF_WIDESTRING url) {
+  std::string url_str =
+      base::UTF16ToUTF8(reinterpret_cast<const base::char16*>(url));
+  // TODO: needs to implement GOTO URL action
+}
+
+int PDFiumEngine::Form_GetLanguage(FPDF_FORMFILLINFO* param,
+                                   void* language,
+                                   int length) {
+  return 0;
+}
+
+#endif  // PDF_USE_XFA
+
 int PDFiumEngine::GetBlock(void* param, unsigned long position,
                            unsigned char* buffer, unsigned long size) {
   DocumentLoader* loader = static_cast<DocumentLoader*>(param);
   return loader->GetBlock(position, size, buffer);
 }
 
 bool PDFiumEngine::IsDataAvail(FX_FILEAVAIL* param,
                                size_t offset, size_t size) {
   PDFiumEngine::FileAvail* file_avail =
       static_cast<PDFiumEngine::FileAvail*>(param);
@@ skipping 251 matching lines @@
     FORM_DoPageAAction(new_page, form_, FPDFPAGE_AACTION_OPEN);
   }
 
   if (doc_) // This can only happen if loading |doc_| fails.
     client_->DocumentLoadComplete(pages_.size());
 }
 
 void PDFiumEngine::UnsupportedFeature(int type) {
   std::string feature;
   switch (type) {
+#ifndef PDF_USE_XFA
     case FPDF_UNSP_DOC_XFAFORM:
       feature = "XFA";
       break;
+#endif
     case FPDF_UNSP_DOC_PORTABLECOLLECTION:
       feature = "Portfolios_Packages";
       break;
     case FPDF_UNSP_DOC_ATTACHMENT:
     case FPDF_UNSP_ANNOT_ATTACHMENT:
       feature = "Attachment";
       break;
     case FPDF_UNSP_DOC_SECURITY:
       feature = "Rights_Management";
       break;
@@ skipping 405 matching lines @@
   if (page_index != -1) {
     last_page_mouse_down_ = page_index;
     double page_x, page_y;
     pp::Point point = event.GetPosition();
     DeviceToPage(page_index, point.x(), point.y(), &page_x, &page_y);
 
     FORM_OnLButtonDown(form_, pages_[page_index]->GetPage(), 0, page_x, page_y);
     int control = FPDPage_HasFormFieldAtPoint(
         form_, pages_[page_index]->GetPage(), page_x, page_y);
     if (control > FPDF_FORMFIELD_UNKNOWN) {  // returns -1 sometimes...
-      client_->FormTextFieldFocusChange(control == FPDF_FORMFIELD_TEXTFIELD ||
-          control == FPDF_FORMFIELD_COMBOBOX);
+#ifdef PDF_USE_XFA
+    client_->FormTextFieldFocusChange(control == FPDF_FORMFIELD_TEXTFIELD ||
+      control == FPDF_FORMFIELD_COMBOBOX || control == FPDF_FORMFIELD_XFA);

[Lei Zhang, 2014/11/06 19:15:29]

nit: 4 space indent on line continuations.

+#else
+    client_->FormTextFieldFocusChange(control == FPDF_FORMFIELD_TEXTFIELD ||
+      control == FPDF_FORMFIELD_COMBOBOX);
+#endif
       return true;  // Return now before we get into the selection code.
     }
   }
 
   client_->FormTextFieldFocusChange(false);
 
   if (area != PDFiumPage::TEXT_AREA)
     return true;  // Return true so WebKit doesn't do its own highlighting.
 
   if (event.GetClickCount() == 1) {
@@ skipping 864 matching lines @@
   if (!form_) {
     // Only returns 0 when data isn't available.  If form data is downloaded, or
     // if this isn't a form, returns positive values.
     if (!doc_loader_.IsDocumentComplete() &&
         !FPDFAvail_IsFormAvail(fpdf_availability_, &download_hints_)) {
       return;
     }
 
     form_ = FPDFDOC_InitFormFillEnviroument(
         doc_, static_cast<FPDF_FORMFILLINFO*>(this));
+#ifdef PDF_USE_XFA
+    FPDF_LoadXFA(doc_);
+#endif
+
     FPDF_SetFormFieldHighlightColor(form_, 0, kFormHighlightColor);
     FPDF_SetFormFieldHighlightAlpha(form_, kFormHighlightAlpha);
   }
 
   if (!doc_loader_.IsDocumentComplete()) {
     // Check if the first page is available.  In a linearized PDF, that is not
     // always page 0.  Doing this gives us the default page size, since when the
     // document is available, the first page is available as well.
     CheckPageAvailable(FPDFAvail_GetFirstPageNum(doc_), &pending_pages_);
   }
@@ skipping 1289 matching lines @@
     double* height) {
   FPDF_DOCUMENT doc = FPDF_LoadMemDocument(pdf_buffer, pdf_buffer_size, NULL);
   if (!doc)
     return false;
   bool success = FPDF_GetPageSizeByIndex(doc, page_number, width, height) != 0;
   FPDF_CloseDocument(doc);
   return success;
 }
 
 }  // namespace chrome_pdf