Fix layering violation in CPDF_Document::FromFPDFDocument().
[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 = CPDF_Bookmark((CPDF_Dictionary*)pDict);
60   return tree.GetFirstChild(bookmark).GetDict();
61 }
62
63 DLLEXPORT FPDF_BOOKMARK STDCALL
64 FPDFBookmark_GetNextSibling(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict) {
65   if (!pDict)
66     return nullptr;
67   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
68   if (!pDoc)
69     return nullptr;
70   CPDF_BookmarkTree tree(pDoc);
71   CPDF_Bookmark bookmark = CPDF_Bookmark((CPDF_Dictionary*)pDict);
72   return tree.GetNextSibling(bookmark).GetDict();
73 }
74
75 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK pDict,
76                                                       void* buffer,
77                                                       unsigned long buflen) {
78   if (!pDict)
79     return 0;
80   CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
81   CFX_WideString title = bookmark.GetTitle();
82   CFX_ByteString encodedTitle = title.UTF16LE_Encode();
83   unsigned long len = encodedTitle.GetLength();
84   if (buffer && buflen >= len) {
85     FXSYS_memcpy(buffer, encodedTitle.c_str(), len);
86   }
87   return len;
88 }
89
90 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_Find(FPDF_DOCUMENT document,
91                                                   FPDF_WIDESTRING title) {
92   if (!title || title[0] == 0)
93     return nullptr;
94   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
95   if (!pDoc)
96     return nullptr;
97   CPDF_BookmarkTree tree(pDoc);
98   FX_STRSIZE len = CFX_WideString::WStringLength(title);
99   CFX_WideString encodedTitle = CFX_WideString::FromUTF16LE(title, len);
100   return FindBookmark(tree, CPDF_Bookmark(), encodedTitle).GetDict();
101 }
102
103 DLLEXPORT FPDF_DEST STDCALL FPDFBookmark_GetDest(FPDF_DOCUMENT document,
104                                                  FPDF_BOOKMARK pDict) {
105   if (!pDict)
106     return nullptr;
107   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
108   if (!pDoc)
109     return nullptr;
110   CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
111   CPDF_Dest dest = bookmark.GetDest(pDoc);
112   if (dest)
113     return dest.GetObject();
114   // If this bookmark is not directly associated with a dest, we try to get
115   // action
116   CPDF_Action action = bookmark.GetAction();
117   if (!action)
118     return nullptr;
119   return action.GetDest(pDoc).GetObject();
120 }
121
122 DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction(FPDF_BOOKMARK pDict) {
123   if (!pDict)
124     return NULL;
125   CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
126   return bookmark.GetAction().GetDict();
127 }
128
129 DLLEXPORT unsigned long STDCALL FPDFAction_GetType(FPDF_ACTION pDict) {
130   if (!pDict)
131     return PDFACTION_UNSUPPORTED;
132
133   CPDF_Action action((CPDF_Dictionary*)pDict);
134   CPDF_Action::ActionType type = action.GetType();
135   switch (type) {
136     case CPDF_Action::GoTo:
137       return PDFACTION_GOTO;
138     case CPDF_Action::GoToR:
139       return PDFACTION_REMOTEGOTO;
140     case CPDF_Action::URI:
141       return PDFACTION_URI;
142     case CPDF_Action::Launch:
143       return PDFACTION_LAUNCH;
144     default:
145       return PDFACTION_UNSUPPORTED;
146   }
147 }
148
149 DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest(FPDF_DOCUMENT document,
150                                                FPDF_ACTION pDict) {
151   if (!pDict)
152     return nullptr;
153   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
154   if (!pDoc)
155     return nullptr;
156   CPDF_Action action((CPDF_Dictionary*)pDict);
157   return action.GetDest(pDoc).GetObject();
158 }
159
160 DLLEXPORT unsigned long STDCALL
161 FPDFAction_GetFilePath(FPDF_ACTION pDict, void* buffer, unsigned long buflen) {
162   unsigned long type = FPDFAction_GetType(pDict);
163   if (type != PDFACTION_REMOTEGOTO && type != PDFACTION_LAUNCH)
164     return 0;
165
166   CPDF_Action action((CPDF_Dictionary*)pDict);
167   CFX_ByteString path = action.GetFilePath().UTF8Encode();
168   unsigned long len = path.GetLength() + 1;
169   if (buffer && buflen >= len)
170     FXSYS_memcpy(buffer, path.c_str(), len);
171   return len;
172 }
173
174 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document,
175                                                       FPDF_ACTION pDict,
176                                                       void* buffer,
177                                                       unsigned long buflen) {
178   if (!pDict)
179     return 0;
180   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
181   if (!pDoc)
182     return 0;
183   CPDF_Action action((CPDF_Dictionary*)pDict);
184   CFX_ByteString path = action.GetURI(pDoc);
185   unsigned long len = path.GetLength() + 1;
186   if (buffer && buflen >= len)
187     FXSYS_memcpy(buffer, path.c_str(), len);
188   return len;
189 }
190
191 DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex(FPDF_DOCUMENT document,
192                                                       FPDF_DEST pDict) {
193   if (!pDict)
194     return 0;
195   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
196   if (!pDoc)
197     return 0;
198   CPDF_Dest dest((CPDF_Array*)pDict);
199   return dest.GetPageIndex(pDoc);
200 }
201
202 DLLEXPORT FPDF_LINK STDCALL
203 FPDFLink_GetLinkAtPoint(FPDF_PAGE page, double x, double y) {
204   CPDF_Page* pPage = (CPDF_Page*)page;
205   CPDF_LinkList* pLinkList = GetLinkList(pPage);
206   if (!pLinkList)
207     return nullptr;
208
209   return pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y, nullptr)
210       .GetDict();
211 }
212
213 DLLEXPORT int STDCALL
214 FPDFLink_GetLinkZOrderAtPoint(FPDF_PAGE page, double x, double y) {
215   CPDF_Page* pPage = (CPDF_Page*)page;
216   CPDF_LinkList* pLinkList = GetLinkList(pPage);
217   if (!pLinkList)
218     return -1;
219
220   int z_order = -1;
221   pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y, &z_order);
222   return z_order;
223 }
224
225 DLLEXPORT FPDF_DEST STDCALL FPDFLink_GetDest(FPDF_DOCUMENT document,
226                                              FPDF_LINK pDict) {
227   if (!pDict)
228     return nullptr;
229   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
230   if (!pDoc)
231     return nullptr;
232   CPDF_Link link((CPDF_Dictionary*)pDict);
233   FPDF_DEST dest = link.GetDest(pDoc).GetObject();
234   if (dest)
235     return dest;
236   // If this link is not directly associated with a dest, we try to get action
237   CPDF_Action action = link.GetAction();
238   if (!action)
239     return nullptr;
240   return action.GetDest(pDoc).GetObject();
241 }
242
243 DLLEXPORT FPDF_ACTION STDCALL FPDFLink_GetAction(FPDF_LINK pDict) {
244   if (!pDict)
245     return nullptr;
246
247   CPDF_Link link((CPDF_Dictionary*)pDict);
248   return link.GetAction().GetDict();
249 }
250
251 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_Enumerate(FPDF_PAGE page,
252                                                int* startPos,
253                                                FPDF_LINK* linkAnnot) {
254   if (!page || !startPos || !linkAnnot)
255     return FALSE;
256   CPDF_Page* pPage = (CPDF_Page*)page;
257   if (!pPage->m_pFormDict)
258     return FALSE;
259   CPDF_Array* pAnnots = pPage->m_pFormDict->GetArray("Annots");
260   if (!pAnnots)
261     return FALSE;
262   for (int i = *startPos; i < (int)pAnnots->GetCount(); i++) {
263     CPDF_Dictionary* pDict = (CPDF_Dictionary*)pAnnots->GetElementValue(i);
264     if (!pDict || pDict->GetType() != PDFOBJ_DICTIONARY)
265       continue;
266     if (pDict->GetString(FX_BSTRC("Subtype")).Equal(FX_BSTRC("Link"))) {
267       *startPos = i + 1;
268       *linkAnnot = (FPDF_LINK)pDict;
269       return TRUE;
270     }
271   }
272   return FALSE;
273 }
274
275 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetAnnotRect(FPDF_LINK linkAnnot,
276                                                   FS_RECTF* rect) {
277   if (!linkAnnot || !rect)
278     return FALSE;
279   CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
280   CPDF_Rect rt = pAnnotDict->GetRect(FX_BSTRC("Rect"));
281   rect->left = rt.left;
282   rect->bottom = rt.bottom;
283   rect->right = rt.right;
284   rect->top = rt.top;
285   return TRUE;
286 }
287
288 DLLEXPORT int STDCALL FPDFLink_CountQuadPoints(FPDF_LINK linkAnnot) {
289   if (!linkAnnot)
290     return 0;
291   CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
292   CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
293   if (!pArray)
294     return 0;
295   return pArray->GetCount() / 8;
296 }
297
298 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetQuadPoints(FPDF_LINK linkAnnot,
299                                                    int quadIndex,
300                                                    FS_QUADPOINTSF* quadPoints) {
301   if (!linkAnnot || !quadPoints)
302     return FALSE;
303   CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
304   CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
305   if (pArray) {
306     if (quadIndex < 0 || quadIndex >= (int)pArray->GetCount() / 8 ||
307         ((quadIndex * 8 + 7) >= (int)pArray->GetCount()))
308       return FALSE;
309     quadPoints->x1 = pArray->GetNumber(quadIndex * 8);
310     quadPoints->y1 = pArray->GetNumber(quadIndex * 8 + 1);
311     quadPoints->x2 = pArray->GetNumber(quadIndex * 8 + 2);
312     quadPoints->y2 = pArray->GetNumber(quadIndex * 8 + 3);
313     quadPoints->x3 = pArray->GetNumber(quadIndex * 8 + 4);
314     quadPoints->y3 = pArray->GetNumber(quadIndex * 8 + 5);
315     quadPoints->x4 = pArray->GetNumber(quadIndex * 8 + 6);
316     quadPoints->y4 = pArray->GetNumber(quadIndex * 8 + 7);
317     return TRUE;
318   }
319   return FALSE;
320 }
321
322 DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc,
323                                                  FPDF_BYTESTRING tag,
324                                                  void* buffer,
325                                                  unsigned long buflen) {
326   if (!tag)
327     return 0;
328   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(doc);
329   if (!pDoc)
330     return 0;
331   CPDF_Dictionary* pInfo = pDoc->GetInfo();
332   if (!pInfo)
333     return 0;
334   CFX_WideString text = pInfo->GetUnicodeText(tag);
335   // Use UTF-16LE encoding
336   CFX_ByteString encodedText = text.UTF16LE_Encode();
337   unsigned long len = encodedText.GetLength();
338   if (buffer && buflen >= len) {
339     FXSYS_memcpy(buffer, encodedText.c_str(), len);
340   }
341   return len;
342 }