More master side changes for convergence with XFA.
[pdfium.git] / fpdfsdk / src / fpdfdoc.cpp
1 // Copyright 2014 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 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #include "../../public/fpdf_doc.h"
8 #include "../include/fsdk_define.h"
9
10 namespace {
11
12 int THISMODULE = 0;
13
14 CPDF_Bookmark FindBookmark(const CPDF_BookmarkTree& tree,
15                            CPDF_Bookmark bookmark,
16                            const CFX_WideString& title) {
17   if (bookmark && bookmark.GetTitle().CompareNoCase(title.c_str()) == 0) {
18     // First check this item
19     return bookmark;
20   }
21   // go into children items
22   CPDF_Bookmark child = tree.GetFirstChild(bookmark);
23   while (child) {
24     // check if this item
25     CPDF_Bookmark found = FindBookmark(tree, child, title);
26     if (found)
27       return found;
28     child = tree.GetNextSibling(child);
29   }
30   return CPDF_Bookmark();
31 }
32
33 void ReleaseLinkList(void* data) {
34   delete (CPDF_LinkList*)data;
35 }
36
37 CPDF_LinkList* GetLinkList(CPDF_Page* page) {
38   if (!page)
39     return nullptr;
40
41   // Link list is stored with the document
42   CPDF_Document* pDoc = page->m_pDocument;
43   CPDF_LinkList* pLinkList = (CPDF_LinkList*)pDoc->GetPrivateData(&THISMODULE);
44   if (!pLinkList) {
45     pLinkList = new CPDF_LinkList;
46     pDoc->SetPrivateData(&THISMODULE, pLinkList, ReleaseLinkList);
47   }
48   return pLinkList;
49 }
50
51 }  // namespace
52
53 DLLEXPORT FPDF_BOOKMARK STDCALL
54 FPDFBookmark_GetFirstChild(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict) {
55   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
56   if (!pDoc)
57     return nullptr;
58   CPDF_BookmarkTree tree(pDoc);
59   CPDF_Bookmark bookmark =
60       CPDF_Bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
61   return tree.GetFirstChild(bookmark).GetDict();
62 }
63
64 DLLEXPORT FPDF_BOOKMARK STDCALL
65 FPDFBookmark_GetNextSibling(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict) {
66   if (!pDict)
67     return nullptr;
68   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
69   if (!pDoc)
70     return nullptr;
71   CPDF_BookmarkTree tree(pDoc);
72   CPDF_Bookmark bookmark =
73       CPDF_Bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
74   return tree.GetNextSibling(bookmark).GetDict();
75 }
76
77 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK pDict,
78                                                       void* buffer,
79                                                       unsigned long buflen) {
80   if (!pDict)
81     return 0;
82   CPDF_Bookmark bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
83   CFX_WideString title = bookmark.GetTitle();
84   CFX_ByteString encodedTitle = title.UTF16LE_Encode();
85   unsigned long len = encodedTitle.GetLength();
86   if (buffer && buflen >= len) {
87     FXSYS_memcpy(buffer, encodedTitle.c_str(), len);
88   }
89   return len;
90 }
91
92 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_Find(FPDF_DOCUMENT document,
93                                                   FPDF_WIDESTRING title) {
94   if (!title || title[0] == 0)
95     return nullptr;
96   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
97   if (!pDoc)
98     return nullptr;
99   CPDF_BookmarkTree tree(pDoc);
100   FX_STRSIZE len = CFX_WideString::WStringLength(title);
101   CFX_WideString encodedTitle = CFX_WideString::FromUTF16LE(title, len);
102   return FindBookmark(tree, CPDF_Bookmark(), encodedTitle).GetDict();
103 }
104
105 DLLEXPORT FPDF_DEST STDCALL FPDFBookmark_GetDest(FPDF_DOCUMENT document,
106                                                  FPDF_BOOKMARK pDict) {
107   if (!pDict)
108     return nullptr;
109   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
110   if (!pDoc)
111     return nullptr;
112   CPDF_Bookmark bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
113   CPDF_Dest dest = bookmark.GetDest(pDoc);
114   if (dest)
115     return dest.GetObject();
116   // If this bookmark is not directly associated with a dest, we try to get
117   // action
118   CPDF_Action action = bookmark.GetAction();
119   if (!action)
120     return nullptr;
121   return action.GetDest(pDoc).GetObject();
122 }
123
124 DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction(FPDF_BOOKMARK pDict) {
125   if (!pDict)
126     return NULL;
127   CPDF_Bookmark bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
128   return bookmark.GetAction().GetDict();
129 }
130
131 DLLEXPORT unsigned long STDCALL FPDFAction_GetType(FPDF_ACTION pDict) {
132   if (!pDict)
133     return PDFACTION_UNSUPPORTED;
134
135   CPDF_Action action(ToDictionary(static_cast<CPDF_Object*>(pDict)));
136   CPDF_Action::ActionType type = action.GetType();
137   switch (type) {
138     case CPDF_Action::GoTo:
139       return PDFACTION_GOTO;
140     case CPDF_Action::GoToR:
141       return PDFACTION_REMOTEGOTO;
142     case CPDF_Action::URI:
143       return PDFACTION_URI;
144     case CPDF_Action::Launch:
145       return PDFACTION_LAUNCH;
146     default:
147       return PDFACTION_UNSUPPORTED;
148   }
149 }
150
151 DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest(FPDF_DOCUMENT document,
152                                                FPDF_ACTION pDict) {
153   if (!pDict)
154     return nullptr;
155   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
156   if (!pDoc)
157     return nullptr;
158   CPDF_Action action(ToDictionary(static_cast<CPDF_Object*>(pDict)));
159   return action.GetDest(pDoc).GetObject();
160 }
161
162 DLLEXPORT unsigned long STDCALL
163 FPDFAction_GetFilePath(FPDF_ACTION pDict, void* buffer, unsigned long buflen) {
164   unsigned long type = FPDFAction_GetType(pDict);
165   if (type != PDFACTION_REMOTEGOTO && type != PDFACTION_LAUNCH)
166     return 0;
167
168   CPDF_Action action(ToDictionary(static_cast<CPDF_Object*>(pDict)));
169   CFX_ByteString path = action.GetFilePath().UTF8Encode();
170   unsigned long len = path.GetLength() + 1;
171   if (buffer && buflen >= len)
172     FXSYS_memcpy(buffer, path.c_str(), len);
173   return len;
174 }
175
176 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document,
177                                                       FPDF_ACTION pDict,
178                                                       void* buffer,
179                                                       unsigned long buflen) {
180   if (!pDict)
181     return 0;
182   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
183   if (!pDoc)
184     return 0;
185   CPDF_Action action(ToDictionary(static_cast<CPDF_Object*>(pDict)));
186   CFX_ByteString path = action.GetURI(pDoc);
187   unsigned long len = path.GetLength() + 1;
188   if (buffer && buflen >= len)
189     FXSYS_memcpy(buffer, path.c_str(), len);
190   return len;
191 }
192
193 DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex(FPDF_DOCUMENT document,
194                                                       FPDF_DEST pDict) {
195   if (!pDict)
196     return 0;
197   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
198   if (!pDoc)
199     return 0;
200   CPDF_Dest dest((CPDF_Array*)pDict);
201   return dest.GetPageIndex(pDoc);
202 }
203
204 DLLEXPORT FPDF_LINK STDCALL
205 FPDFLink_GetLinkAtPoint(FPDF_PAGE page, double x, double y) {
206   CPDF_Page* pPage = CPDFPageFromFPDFPage(page);
207   if (!pPage)
208     return nullptr;
209
210   CPDF_LinkList* pLinkList = GetLinkList(pPage);
211   if (!pLinkList)
212     return nullptr;
213
214   return pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y, nullptr)
215       .GetDict();
216 }
217
218 DLLEXPORT int STDCALL
219 FPDFLink_GetLinkZOrderAtPoint(FPDF_PAGE page, double x, double y) {
220   CPDF_Page* pPage = CPDFPageFromFPDFPage(page);
221   if (!pPage)
222     return -1;
223
224   CPDF_LinkList* pLinkList = GetLinkList(pPage);
225   if (!pLinkList)
226     return -1;
227
228   int z_order = -1;
229   pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y, &z_order);
230   return z_order;
231 }
232
233 DLLEXPORT FPDF_DEST STDCALL FPDFLink_GetDest(FPDF_DOCUMENT document,
234                                              FPDF_LINK pDict) {
235   if (!pDict)
236     return nullptr;
237   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
238   if (!pDoc)
239     return nullptr;
240   CPDF_Link link(ToDictionary(static_cast<CPDF_Object*>(pDict)));
241   FPDF_DEST dest = link.GetDest(pDoc).GetObject();
242   if (dest)
243     return dest;
244   // If this link is not directly associated with a dest, we try to get action
245   CPDF_Action action = link.GetAction();
246   if (!action)
247     return nullptr;
248   return action.GetDest(pDoc).GetObject();
249 }
250
251 DLLEXPORT FPDF_ACTION STDCALL FPDFLink_GetAction(FPDF_LINK pDict) {
252   if (!pDict)
253     return nullptr;
254
255   CPDF_Link link(ToDictionary(static_cast<CPDF_Object*>(pDict)));
256   return link.GetAction().GetDict();
257 }
258
259 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_Enumerate(FPDF_PAGE page,
260                                                int* startPos,
261                                                FPDF_LINK* linkAnnot) {
262   if (!startPos || !linkAnnot)
263     return FALSE;
264   CPDF_Page* pPage = CPDFPageFromFPDFPage(page);
265   if (!pPage || !pPage->m_pFormDict)
266     return FALSE;
267   CPDF_Array* pAnnots = pPage->m_pFormDict->GetArray("Annots");
268   if (!pAnnots)
269     return FALSE;
270   for (int i = *startPos; i < (int)pAnnots->GetCount(); i++) {
271     CPDF_Dictionary* pDict =
272         ToDictionary(static_cast<CPDF_Object*>(pAnnots->GetElementValue(i)));
273     if (!pDict)
274       continue;
275     if (pDict->GetString(FX_BSTRC("Subtype")).Equal(FX_BSTRC("Link"))) {
276       *startPos = i + 1;
277       *linkAnnot = (FPDF_LINK)pDict;
278       return TRUE;
279     }
280   }
281   return FALSE;
282 }
283
284 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetAnnotRect(FPDF_LINK linkAnnot,
285                                                   FS_RECTF* rect) {
286   if (!linkAnnot || !rect)
287     return FALSE;
288   CPDF_Dictionary* pAnnotDict =
289       ToDictionary(static_cast<CPDF_Object*>(linkAnnot));
290   CPDF_Rect rt = pAnnotDict->GetRect(FX_BSTRC("Rect"));
291   rect->left = rt.left;
292   rect->bottom = rt.bottom;
293   rect->right = rt.right;
294   rect->top = rt.top;
295   return TRUE;
296 }
297
298 DLLEXPORT int STDCALL FPDFLink_CountQuadPoints(FPDF_LINK linkAnnot) {
299   if (!linkAnnot)
300     return 0;
301   CPDF_Dictionary* pAnnotDict =
302       ToDictionary(static_cast<CPDF_Object*>(linkAnnot));
303   CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
304   if (!pArray)
305     return 0;
306   return pArray->GetCount() / 8;
307 }
308
309 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetQuadPoints(FPDF_LINK linkAnnot,
310                                                    int quadIndex,
311                                                    FS_QUADPOINTSF* quadPoints) {
312   if (!linkAnnot || !quadPoints)
313     return FALSE;
314   CPDF_Dictionary* pAnnotDict =
315       ToDictionary(static_cast<CPDF_Object*>(linkAnnot));
316   CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
317   if (pArray) {
318     if (quadIndex < 0 || quadIndex >= (int)pArray->GetCount() / 8 ||
319         ((quadIndex * 8 + 7) >= (int)pArray->GetCount()))
320       return FALSE;
321     quadPoints->x1 = pArray->GetNumber(quadIndex * 8);
322     quadPoints->y1 = pArray->GetNumber(quadIndex * 8 + 1);
323     quadPoints->x2 = pArray->GetNumber(quadIndex * 8 + 2);
324     quadPoints->y2 = pArray->GetNumber(quadIndex * 8 + 3);
325     quadPoints->x3 = pArray->GetNumber(quadIndex * 8 + 4);
326     quadPoints->y3 = pArray->GetNumber(quadIndex * 8 + 5);
327     quadPoints->x4 = pArray->GetNumber(quadIndex * 8 + 6);
328     quadPoints->y4 = pArray->GetNumber(quadIndex * 8 + 7);
329     return TRUE;
330   }
331   return FALSE;
332 }
333
334 DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc,
335                                                  FPDF_BYTESTRING tag,
336                                                  void* buffer,
337                                                  unsigned long buflen) {
338   if (!tag)
339     return 0;
340   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(doc);
341   if (!pDoc)
342     return 0;
343   CPDF_Dictionary* pInfo = pDoc->GetInfo();
344   if (!pInfo)
345     return 0;
346   CFX_WideString text = pInfo->GetUnicodeText(tag);
347   // Use UTF-16LE encoding
348   CFX_ByteString encodedText = text.UTF16LE_Encode();
349   unsigned long len = encodedText.GetLength();
350   if (buffer && buflen >= len) {
351     FXSYS_memcpy(buffer, encodedText.c_str(), len);
352   }
353   return len;
354 }