Remove unneeded checks for CPDF_Object::GetDict() return values.
[pdfium.git] / core / src / fpdfapi / fpdf_parser / fpdf_parser_document.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 "../../../include/fpdfapi/fpdf_parser.h"
8 #include "../../../include/fpdfapi/fpdf_module.h"
9
10 CPDF_Document::CPDF_Document(CPDF_Parser* pParser)
11     : CPDF_IndirectObjects(pParser) {
12   ASSERT(pParser != NULL);
13   m_pRootDict = NULL;
14   m_pInfoDict = NULL;
15   m_bLinearized = FALSE;
16   m_dwFirstPageNo = 0;
17   m_dwFirstPageObjNum = 0;
18   m_pDocPage = CPDF_ModuleMgr::Get()->GetPageModule()->CreateDocData(this);
19   m_pDocRender = CPDF_ModuleMgr::Get()->GetRenderModule()->CreateDocData(this);
20 }
21 CPDF_DocPageData* CPDF_Document::GetValidatePageData() {
22   if (m_pDocPage) {
23     return m_pDocPage;
24   }
25   m_pDocPage = CPDF_ModuleMgr::Get()->GetPageModule()->CreateDocData(this);
26   return m_pDocPage;
27 }
28 CPDF_DocRenderData* CPDF_Document::GetValidateRenderData() {
29   if (m_pDocRender) {
30     return m_pDocRender;
31   }
32   m_pDocRender = CPDF_ModuleMgr::Get()->GetRenderModule()->CreateDocData(this);
33   return m_pDocRender;
34 }
35 void CPDF_Document::LoadDoc() {
36   m_LastObjNum = m_pParser->GetLastObjNum();
37   CPDF_Object* pRootObj = GetIndirectObject(m_pParser->GetRootObjNum());
38   if (pRootObj == NULL) {
39     return;
40   }
41   m_pRootDict = pRootObj->GetDict();
42   if (m_pRootDict == NULL) {
43     return;
44   }
45   CPDF_Object* pInfoObj = GetIndirectObject(m_pParser->GetInfoObjNum());
46   if (pInfoObj) {
47     m_pInfoDict = pInfoObj->GetDict();
48   }
49   CPDF_Array* pIDArray = m_pParser->GetIDArray();
50   if (pIDArray) {
51     m_ID1 = pIDArray->GetString(0);
52     m_ID2 = pIDArray->GetString(1);
53   }
54   m_PageList.SetSize(_GetPageCount());
55 }
56 void CPDF_Document::LoadAsynDoc(CPDF_Dictionary* pLinearized) {
57   m_bLinearized = TRUE;
58   m_LastObjNum = m_pParser->GetLastObjNum();
59   CPDF_Object* indirectObj = GetIndirectObject(m_pParser->GetRootObjNum());
60   m_pRootDict = indirectObj ? indirectObj->GetDict() : NULL;
61   if (m_pRootDict == NULL) {
62     return;
63   }
64   indirectObj = GetIndirectObject(m_pParser->GetInfoObjNum());
65   m_pInfoDict = indirectObj ? indirectObj->GetDict() : NULL;
66   CPDF_Array* pIDArray = m_pParser->GetIDArray();
67   if (pIDArray) {
68     m_ID1 = pIDArray->GetString(0);
69     m_ID2 = pIDArray->GetString(1);
70   }
71   FX_DWORD dwPageCount = 0;
72   CPDF_Object* pCount = pLinearized->GetElement(FX_BSTRC("N"));
73   if (pCount && pCount->GetType() == PDFOBJ_NUMBER) {
74     dwPageCount = pCount->GetInteger();
75   }
76   m_PageList.SetSize(dwPageCount);
77   CPDF_Object* pNo = pLinearized->GetElement(FX_BSTRC("P"));
78   if (pNo && pNo->GetType() == PDFOBJ_NUMBER) {
79     m_dwFirstPageNo = pNo->GetInteger();
80   }
81   CPDF_Object* pObjNum = pLinearized->GetElement(FX_BSTRC("O"));
82   if (pObjNum && pObjNum->GetType() == PDFOBJ_NUMBER) {
83     m_dwFirstPageObjNum = pObjNum->GetInteger();
84   }
85 }
86 void CPDF_Document::LoadPages() {
87   m_PageList.SetSize(_GetPageCount());
88 }
89 CPDF_Document::~CPDF_Document() {
90   if (m_pDocPage) {
91     CPDF_ModuleMgr::Get()->GetPageModule()->ReleaseDoc(this);
92     CPDF_ModuleMgr::Get()->GetPageModule()->ClearStockFont(this);
93   }
94   if (m_pDocRender) {
95     CPDF_ModuleMgr::Get()->GetRenderModule()->DestroyDocData(m_pDocRender);
96   }
97 }
98 #define FX_MAX_PAGE_LEVEL 1024
99 CPDF_Dictionary* CPDF_Document::_FindPDFPage(CPDF_Dictionary* pPages,
100                                              int iPage,
101                                              int nPagesToGo,
102                                              int level) {
103   CPDF_Array* pKidList = pPages->GetArray(FX_BSTRC("Kids"));
104   if (pKidList == NULL) {
105     if (nPagesToGo == 0) {
106       return pPages;
107     }
108     return NULL;
109   }
110   if (level >= FX_MAX_PAGE_LEVEL) {
111     return NULL;
112   }
113   int nKids = pKidList->GetCount();
114   for (int i = 0; i < nKids; i++) {
115     CPDF_Dictionary* pKid = pKidList->GetDict(i);
116     if (pKid == NULL) {
117       nPagesToGo--;
118       continue;
119     }
120     if (pKid == pPages) {
121       continue;
122     }
123     if (!pKid->KeyExist(FX_BSTRC("Kids"))) {
124       if (nPagesToGo == 0) {
125         return pKid;
126       }
127       m_PageList.SetAt(iPage - nPagesToGo, pKid->GetObjNum());
128       nPagesToGo--;
129     } else {
130       int nPages = pKid->GetInteger(FX_BSTRC("Count"));
131       if (nPagesToGo < nPages) {
132         return _FindPDFPage(pKid, iPage, nPagesToGo, level + 1);
133       }
134       nPagesToGo -= nPages;
135     }
136   }
137   return NULL;
138 }
139
140 CPDF_Dictionary* CPDF_Document::GetPage(int iPage) {
141   if (iPage < 0 || iPage >= m_PageList.GetSize())
142     return nullptr;
143
144   if (m_bLinearized && (iPage == (int)m_dwFirstPageNo)) {
145     CPDF_Object* pObj = GetIndirectObject(m_dwFirstPageObjNum);
146     if (pObj && pObj->GetType() == PDFOBJ_DICTIONARY) {
147       return static_cast<CPDF_Dictionary*>(pObj);
148     }
149   }
150
151   int objnum = m_PageList.GetAt(iPage);
152   if (objnum) {
153     CPDF_Object* pObj = GetIndirectObject(objnum);
154     if (pObj && pObj->GetType() == PDFOBJ_DICTIONARY) {
155       return static_cast<CPDF_Dictionary*>(pObj);
156     }
157   }
158
159   CPDF_Dictionary* pRoot = GetRoot();
160   if (!pRoot)
161     return nullptr;
162
163   CPDF_Dictionary* pPages = pRoot->GetDict(FX_BSTRC("Pages"));
164   if (!pPages)
165     return nullptr;
166
167   CPDF_Dictionary* pPage = _FindPDFPage(pPages, iPage, iPage, 0);
168   if (!pPage)
169     return nullptr;
170
171   m_PageList.SetAt(iPage, pPage->GetObjNum());
172   return pPage;
173 }
174
175 int CPDF_Document::_FindPageIndex(CPDF_Dictionary* pNode,
176                                   FX_DWORD& skip_count,
177                                   FX_DWORD objnum,
178                                   int& index,
179                                   int level) {
180   if (pNode->KeyExist(FX_BSTRC("Kids"))) {
181     CPDF_Array* pKidList = pNode->GetArray(FX_BSTRC("Kids"));
182     if (pKidList == NULL) {
183       return -1;
184     }
185     if (level >= FX_MAX_PAGE_LEVEL) {
186       return -1;
187     }
188     FX_DWORD count = pNode->GetInteger(FX_BSTRC("Count"));
189     if (count <= skip_count) {
190       skip_count -= count;
191       index += count;
192       return -1;
193     }
194     if (count && count == pKidList->GetCount()) {
195       for (FX_DWORD i = 0; i < count; i++) {
196         CPDF_Object* pKid = pKidList->GetElement(i);
197         if (pKid && pKid->GetType() == PDFOBJ_REFERENCE) {
198           if (((CPDF_Reference*)pKid)->GetRefObjNum() == objnum) {
199             m_PageList.SetAt(index + i, objnum);
200             return index + i;
201           }
202         }
203       }
204     }
205     for (FX_DWORD i = 0; i < pKidList->GetCount(); i++) {
206       CPDF_Dictionary* pKid = pKidList->GetDict(i);
207       if (pKid == NULL) {
208         continue;
209       }
210       if (pKid == pNode) {
211         continue;
212       }
213       int found_index =
214           _FindPageIndex(pKid, skip_count, objnum, index, level + 1);
215       if (found_index >= 0) {
216         return found_index;
217       }
218     }
219   } else {
220     if (objnum == pNode->GetObjNum()) {
221       return index;
222     }
223     if (skip_count) {
224       skip_count--;
225     }
226     index++;
227   }
228   return -1;
229 }
230 int CPDF_Document::GetPageIndex(FX_DWORD objnum) {
231   FX_DWORD nPages = m_PageList.GetSize();
232   FX_DWORD skip_count = 0;
233   FX_BOOL bSkipped = FALSE;
234   for (FX_DWORD i = 0; i < nPages; i++) {
235     FX_DWORD objnum1 = m_PageList.GetAt(i);
236     if (objnum1 == objnum) {
237       return i;
238     }
239     if (!bSkipped && objnum1 == 0) {
240       skip_count = i;
241       bSkipped = TRUE;
242     }
243   }
244   CPDF_Dictionary* pRoot = GetRoot();
245   if (pRoot == NULL) {
246     return -1;
247   }
248   CPDF_Dictionary* pPages = pRoot->GetDict(FX_BSTRC("Pages"));
249   if (pPages == NULL) {
250     return -1;
251   }
252   int index = 0;
253   return _FindPageIndex(pPages, skip_count, objnum, index);
254 }
255 int CPDF_Document::GetPageCount() const {
256   return m_PageList.GetSize();
257 }
258 static int _CountPages(CPDF_Dictionary* pPages, int level) {
259   if (level > 128) {
260     return 0;
261   }
262   int count = pPages->GetInteger(FX_BSTRC("Count"));
263   if (count > 0 && count < FPDF_PAGE_MAX_NUM) {
264     return count;
265   }
266   CPDF_Array* pKidList = pPages->GetArray(FX_BSTRC("Kids"));
267   if (pKidList == NULL) {
268     return 0;
269   }
270   count = 0;
271   for (FX_DWORD i = 0; i < pKidList->GetCount(); i++) {
272     CPDF_Dictionary* pKid = pKidList->GetDict(i);
273     if (pKid == NULL) {
274       continue;
275     }
276     if (!pKid->KeyExist(FX_BSTRC("Kids"))) {
277       count++;
278     } else {
279       count += _CountPages(pKid, level + 1);
280     }
281   }
282   pPages->SetAtInteger(FX_BSTRC("Count"), count);
283   return count;
284 }
285 int CPDF_Document::_GetPageCount() const {
286   CPDF_Dictionary* pRoot = GetRoot();
287   if (pRoot == NULL) {
288     return 0;
289   }
290   CPDF_Dictionary* pPages = pRoot->GetDict(FX_BSTRC("Pages"));
291   if (pPages == NULL) {
292     return 0;
293   }
294   if (!pPages->KeyExist(FX_BSTRC("Kids"))) {
295     return 1;
296   }
297   return _CountPages(pPages, 0);
298 }
299 FX_BOOL CPDF_Document::IsContentUsedElsewhere(FX_DWORD objnum,
300                                               CPDF_Dictionary* pThisPageDict) {
301   for (int i = 0; i < m_PageList.GetSize(); i++) {
302     CPDF_Dictionary* pPageDict = GetPage(i);
303     if (pPageDict == pThisPageDict) {
304       continue;
305     }
306     CPDF_Object* pContents =
307         pPageDict ? pPageDict->GetElement(FX_BSTRC("Contents")) : NULL;
308     if (pContents == NULL) {
309       continue;
310     }
311     if (pContents->GetDirectType() == PDFOBJ_ARRAY) {
312       CPDF_Array* pArray = (CPDF_Array*)pContents->GetDirect();
313       for (FX_DWORD j = 0; j < pArray->GetCount(); j++) {
314         CPDF_Object* pRef = pArray->GetElement(j);
315         if (pRef == NULL || pRef->GetType() != PDFOBJ_REFERENCE) {
316           continue;
317         }
318         if (((CPDF_Reference*)pRef)->GetRefObjNum() == objnum) {
319           return TRUE;
320         }
321       }
322     } else if (pContents->GetObjNum() == objnum) {
323       return TRUE;
324     }
325   }
326   return FALSE;
327 }
328 FX_DWORD CPDF_Document::GetUserPermissions(FX_BOOL bCheckRevision) const {
329   if (m_pParser == NULL) {
330     return (FX_DWORD)-1;
331   }
332   return m_pParser->GetPermissions(bCheckRevision);
333 }
334 FX_BOOL CPDF_Document::IsOwner() const {
335   if (m_pParser == NULL) {
336     return TRUE;
337   }
338   return m_pParser->IsOwner();
339 }
340 FX_BOOL CPDF_Document::IsFormStream(FX_DWORD objnum, FX_BOOL& bForm) const {
341   {
342     CPDF_Object* pObj;
343     if (m_IndirectObjs.Lookup((void*)(uintptr_t)objnum, (void*&)pObj)) {
344       bForm = pObj->GetType() == PDFOBJ_STREAM &&
345               ((CPDF_Stream*)pObj)->GetDict()->GetString(FX_BSTRC("Subtype")) ==
346                   FX_BSTRC("Form");
347       return TRUE;
348     }
349   }
350   if (m_pParser == NULL) {
351     bForm = FALSE;
352     return TRUE;
353   }
354   return m_pParser->IsFormStream(objnum, bForm);
355 }
356 void CPDF_Document::ClearPageData() {
357   if (m_pDocPage) {
358     CPDF_ModuleMgr::Get()->GetPageModule()->ClearDoc(this);
359   }
360 }
361 void CPDF_Document::ClearRenderData() {
362   if (m_pDocRender) {
363     CPDF_ModuleMgr::Get()->GetRenderModule()->ClearDocData(m_pDocRender);
364   }
365 }