Implement FPDFAction_GetFilePath().

fpdfsdk/src/fpdfdoc.cpp

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #include "../include/fsdk_define.h"
 #include "../../public/fpdf_doc.h"
 
 namespace {
@@ skipping 108 matching lines @@
 
 DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction(FPDF_BOOKMARK pDict) {
   if (!pDict)
     return NULL;
   CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
   return bookmark.GetAction().GetDict();
 }
 
 DLLEXPORT unsigned long STDCALL FPDFAction_GetType(FPDF_ACTION pDict) {
   if (!pDict)
-    return 0;
+    return PDFACTION_UNSUPPORTED;
+
   CPDF_Action action((CPDF_Dictionary*)pDict);
   CPDF_Action::ActionType type = action.GetType();
   switch (type) {
     case CPDF_Action::GoTo:
       return PDFACTION_GOTO;
     case CPDF_Action::GoToR:
       return PDFACTION_REMOTEGOTO;
     case CPDF_Action::URI:
       return PDFACTION_URI;
     case CPDF_Action::Launch:
       return PDFACTION_LAUNCH;
     default:
       return PDFACTION_UNSUPPORTED;
   }
-  return PDFACTION_UNSUPPORTED;
 }
 
 DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest(FPDF_DOCUMENT document,
                                                FPDF_ACTION pDict) {
   if (!document)

[jun_fang, 2015/09/14 14:18:57]

if (!document || !pDict)
  return NULL;

[Lei Zhang, 2015/09/15 08:24:50]

Done. (note this is existing code that I didn't write)

     return NULL;
   if (!pDict)
     return NULL;
   CPDF_Document* pDoc = (CPDF_Document*)document;
   CPDF_Action action((CPDF_Dictionary*)pDict);
   return action.GetDest(pDoc).GetObject();
 }
 
+DLLEXPORT unsigned long STDCALL
+FPDFAction_GetFilePath(FPDF_ACTION pDict, void* buffer, unsigned long buflen) {
+  unsigned long type = FPDFAction_GetType(pDict);
+  if (type != PDFACTION_REMOTEGOTO && type != PDFACTION_LAUNCH)
+    return 0;
+
+  CPDF_Action action((CPDF_Dictionary*)pDict);
+  CFX_ByteString path = action.GetFilePath().UTF8Encode();
+  unsigned long len = path.GetLength() + 1;
+  if (buffer && buflen >= len)

[jun_fang, 2015/09/14 12:10:43]

it should return 0 in 'else' rather than len.

[Lei Zhang, 2015/09/15 08:24:50]

Are you saying I should write the following?

if (buffer && buflen >= len) {
  FXSYS_memcpy(buffer, path.c_str(), len);
  return len;
}
return 0;  // (else case)
  

[jun_fang, 2015/09/15 08:35:03]

yes. For else cases, when buffer is null or buflen is less than len,
the memory that buffer points to is invalid for callers. We need
to inform the callers by the returned value (0). 

[Lei Zhang, 2015/09/15 08:50:57]

But returning 0 contradicts the comments section of the documentation for this
function in the header file. Same for FPDFAction_GetURIPath() below. It's ok to
call FPDFAction_GetFilePath(action, nullptr, 0) and get back a non-zero value,
because that value is then used to allocate memory for a second
FPDFAction_GetFilePath(action, buf, previous_retval) call.

+    FXSYS_memcpy(buffer, path.c_str(), len);
+  return len;
+}
+
 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document,
                                                       FPDF_ACTION pDict,
                                                       void* buffer,
                                                       unsigned long buflen) {
   if (!document)

[jun_fang, 2015/09/14 14:18:57]

if (!document || !pDict)
  return 0;

[Lei Zhang, 2015/09/15 08:24:50]

Done.

     return 0;
   if (!pDict)
     return 0;
   CPDF_Document* pDoc = (CPDF_Document*)document;
   CPDF_Action action((CPDF_Dictionary*)pDict);
   CFX_ByteString path = action.GetURI(pDoc);
   unsigned long len = path.GetLength() + 1;
   if (buffer != NULL && buflen >= len)

[jun_fang, 2015/09/14 14:18:57]

if (!buffer && buflen >= len)

[jun_fang, 2015/09/14 14:18:57]

It should return 0 in 'else'.

[Lei Zhang, 2015/09/15 08:24:50]

Done.

     FXSYS_memcpy(buffer, path.c_str(), len);
   return len;
 }
 
 DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex(FPDF_DOCUMENT document,
                                                       FPDF_DEST pDict) {
   if (!document)

[jun_fang, 2015/09/14 14:18:57]

The same as above.

[Lei Zhang, 2015/09/15 08:24:50]

Done.

     return 0;
   if (!pDict)
     return 0;
   CPDF_Document* pDoc = (CPDF_Document*)document;
   CPDF_Dest dest((CPDF_Array*)pDict);
   return dest.GetPageIndex(pDoc);
 }
 
 DLLEXPORT FPDF_LINK STDCALL
 FPDFLink_GetLinkAtPoint(FPDF_PAGE page, double x, double y) {
@@ skipping 13 matching lines @@
   if (!pLinkList)
     return -1;
 
   int z_order = -1;
   pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y, &z_order);
   return z_order;
 }
 
 DLLEXPORT FPDF_DEST STDCALL FPDFLink_GetDest(FPDF_DOCUMENT document,
                                              FPDF_LINK pDict) {
   if (!document)

[jun_fang, 2015/09/14 14:18:57]

The same as above.

[Lei Zhang, 2015/09/15 08:24:50]

Done.

     return NULL;
   if (!pDict)
     return NULL;
   CPDF_Document* pDoc = (CPDF_Document*)document;
   CPDF_Link link((CPDF_Dictionary*)pDict);
   FPDF_DEST dest = link.GetDest(pDoc).GetObject();
   if (dest)
     return dest;
   // If this link is not directly associated with a dest, we try to get action
   CPDF_Action action = link.GetAction();
@@ skipping 93 matching lines @@
     return 0;
   CFX_WideString text = pInfo->GetUnicodeText(tag);
   // Use UTF-16LE encoding
   CFX_ByteString encodedText = text.UTF16LE_Encode();
   unsigned long len = encodedText.GetLength();
   if (buffer && buflen >= len) {
     FXSYS_memcpy(buffer, encodedText.c_str(), len);
   }
   return len;
 }