74e33b56a902844011fe9480f435f488b5c5ae1c
[pdfium.git] / core / src / fpdfapi / fpdf_page / fpdf_page_doc.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_page.h"
8 #include "../../../include/fpdfapi/fpdf_module.h"
9 #include "../../../include/fdrm/fx_crypt.h"
10 #include "../fpdf_font/font_int.h"
11 #include "pageint.h"
12
13 class CPDF_PageModule : public IPDF_PageModule {
14  public:
15   CPDF_PageModule()
16       : m_StockGrayCS(nullptr, PDFCS_DEVICEGRAY),
17         m_StockRGBCS(nullptr, PDFCS_DEVICERGB),
18         m_StockCMYKCS(nullptr, PDFCS_DEVICECMYK),
19         m_StockPatternCS(nullptr) {}
20
21  private:
22   ~CPDF_PageModule() override {}
23
24   CPDF_DocPageData* CreateDocData(CPDF_Document* pDoc) override {
25     return new CPDF_DocPageData(pDoc);
26   }
27
28   void ReleaseDoc(CPDF_Document* pDoc) override;
29   void ClearDoc(CPDF_Document* pDoc) override;
30
31   CPDF_FontGlobals* GetFontGlobals() override { return &m_FontGlobals; }
32
33   void ClearStockFont(CPDF_Document* pDoc) override {
34     m_FontGlobals.Clear(pDoc);
35   }
36
37   CPDF_ColorSpace* GetStockCS(int family) override;
38   void NotifyCJKAvailable() override;
39
40   CPDF_FontGlobals m_FontGlobals;
41   CPDF_DeviceCS m_StockGrayCS;
42   CPDF_DeviceCS m_StockRGBCS;
43   CPDF_DeviceCS m_StockCMYKCS;
44   CPDF_PatternCS m_StockPatternCS;
45 };
46
47 CPDF_ColorSpace* CPDF_PageModule::GetStockCS(int family) {
48   if (family == PDFCS_DEVICEGRAY) {
49     return &m_StockGrayCS;
50   }
51   if (family == PDFCS_DEVICERGB) {
52     return &m_StockRGBCS;
53   }
54   if (family == PDFCS_DEVICECMYK) {
55     return &m_StockCMYKCS;
56   }
57   if (family == PDFCS_PATTERN) {
58     return &m_StockPatternCS;
59   }
60   return NULL;
61 }
62
63 void CPDF_ModuleMgr::InitPageModule() {
64   m_pPageModule.reset(new CPDF_PageModule);
65 }
66
67 void CPDF_PageModule::ReleaseDoc(CPDF_Document* pDoc) {
68   delete pDoc->GetPageData();
69 }
70 void CPDF_PageModule::ClearDoc(CPDF_Document* pDoc) {
71   pDoc->GetPageData()->Clear(FALSE);
72 }
73 void CPDF_PageModule::NotifyCJKAvailable() {
74   m_FontGlobals.m_CMapManager.ReloadAll();
75 }
76
77 CPDF_Font* CPDF_Document::LoadFont(CPDF_Dictionary* pFontDict) {
78   ASSERT(pFontDict);
79   return GetValidatePageData()->GetFont(pFontDict, FALSE);
80 }
81
82 CPDF_StreamAcc* CPDF_Document::LoadFontFile(CPDF_Stream* pStream) {
83   return GetValidatePageData()->GetFontFileStreamAcc(pStream);
84 }
85
86 CPDF_ColorSpace* _CSFromName(const CFX_ByteString& name);
87 CPDF_ColorSpace* CPDF_Document::LoadColorSpace(CPDF_Object* pCSObj,
88                                                CPDF_Dictionary* pResources) {
89   return GetValidatePageData()->GetColorSpace(pCSObj, pResources);
90 }
91 CPDF_Pattern* CPDF_Document::LoadPattern(CPDF_Object* pPatternObj,
92                                          FX_BOOL bShading,
93                                          const CFX_AffineMatrix* matrix) {
94   return GetValidatePageData()->GetPattern(pPatternObj, bShading, matrix);
95 }
96 CPDF_IccProfile* CPDF_Document::LoadIccProfile(CPDF_Stream* pStream) {
97   return GetValidatePageData()->GetIccProfile(pStream);
98 }
99 CPDF_Image* CPDF_Document::LoadImageF(CPDF_Object* pObj) {
100   if (!pObj) {
101     return NULL;
102   }
103   FXSYS_assert(pObj->GetObjNum());
104   return GetValidatePageData()->GetImage(pObj);
105 }
106 void CPDF_Document::RemoveColorSpaceFromPageData(CPDF_Object* pCSObj) {
107   if (!pCSObj) {
108     return;
109   }
110   GetPageData()->ReleaseColorSpace(pCSObj);
111 }
112 CPDF_DocPageData::CPDF_DocPageData(CPDF_Document* pPDFDoc)
113     : m_pPDFDoc(pPDFDoc), m_bForceClear(FALSE) {}
114
115 CPDF_DocPageData::~CPDF_DocPageData() {
116   Clear(FALSE);
117   Clear(TRUE);
118
119   for (auto& it : m_PatternMap)
120     delete it.second;
121   m_PatternMap.clear();
122
123   for (auto& it : m_FontMap)
124     delete it.second;
125   m_FontMap.clear();
126
127   for (auto& it : m_ColorSpaceMap)
128     delete it.second;
129   m_ColorSpaceMap.clear();
130 }
131
132 void CPDF_DocPageData::Clear(FX_BOOL bForceRelease) {
133   m_bForceClear = bForceRelease;
134
135   for (auto& it : m_PatternMap) {
136     CPDF_CountedPattern* ptData = it.second;
137     if (!ptData->get())
138       continue;
139
140     if (bForceRelease || ptData->use_count() < 2) {
141       ptData->get()->SetForceClear(bForceRelease);
142       ptData->clear();
143     }
144   }
145
146   for (auto& it : m_FontMap) {
147     CPDF_CountedFont* fontData = it.second;
148     if (!fontData->get())
149       continue;
150
151     if (bForceRelease || fontData->use_count() < 2) {
152       fontData->clear();
153     }
154   }
155
156   for (auto& it : m_ColorSpaceMap) {
157     CPDF_CountedColorSpace* csData = it.second;
158     if (!csData->get())
159       continue;
160
161     if (bForceRelease || csData->use_count() < 2) {
162       csData->get()->ReleaseCS();
163       csData->reset(nullptr);
164     }
165   }
166
167   for (auto it = m_IccProfileMap.begin(); it != m_IccProfileMap.end();) {
168     auto curr_it = it++;
169     CPDF_CountedIccProfile* ipData = curr_it->second;
170     if (!ipData->get())
171       continue;
172
173     if (bForceRelease || ipData->use_count() < 2) {
174       CPDF_Stream* ipKey = curr_it->first;
175       FX_POSITION pos2 = m_HashProfileMap.GetStartPosition();
176       while (pos2) {
177         CFX_ByteString bsKey;
178         CPDF_Stream* pFindStream = nullptr;
179         m_HashProfileMap.GetNextAssoc(pos2, bsKey, (void*&)pFindStream);
180         if (ipKey == pFindStream) {
181           m_HashProfileMap.RemoveKey(bsKey);
182           break;
183         }
184       }
185       delete ipData->get();
186       delete ipData;
187       m_IccProfileMap.erase(curr_it);
188     }
189   }
190
191   for (auto it = m_FontFileMap.begin(); it != m_FontFileMap.end();) {
192     auto curr_it = it++;
193     CPDF_CountedStreamAcc* ftData = curr_it->second;
194     if (!ftData->get())
195       continue;
196
197     if (bForceRelease || ftData->use_count() < 2) {
198       delete ftData->get();
199       delete ftData;
200       m_FontFileMap.erase(curr_it);
201     }
202   }
203
204   for (auto it = m_ImageMap.begin(); it != m_ImageMap.end();) {
205     auto curr_it = it++;
206     CPDF_CountedImage* imageData = curr_it->second;
207     if (!imageData->get())
208       continue;
209
210     if (bForceRelease || imageData->use_count() < 2) {
211       delete imageData->get();
212       delete imageData;
213       m_ImageMap.erase(curr_it);
214     }
215   }
216 }
217
218 CPDF_Font* CPDF_DocPageData::GetFont(CPDF_Dictionary* pFontDict,
219                                      FX_BOOL findOnly) {
220   if (!pFontDict) {
221     return NULL;
222   }
223   if (findOnly) {
224     auto it = m_FontMap.find(pFontDict);
225     if (it != m_FontMap.end() && it->second->get()) {
226       return it->second->AddRef();
227     }
228     return nullptr;
229   }
230
231   CPDF_CountedFont* fontData = nullptr;
232   auto it = m_FontMap.find(pFontDict);
233   if (it != m_FontMap.end()) {
234     fontData = it->second;
235     if (fontData->get()) {
236       return fontData->AddRef();
237     }
238   }
239
240   CPDF_Font* pFont = CPDF_Font::CreateFontF(m_pPDFDoc, pFontDict);
241   if (!pFont) {
242     return nullptr;
243   }
244   if (!fontData) {
245     fontData = new CPDF_CountedFont(pFont);
246     m_FontMap[pFontDict] = fontData;
247   } else {
248     fontData->reset(pFont);
249   }
250   return fontData->AddRef();
251 }
252
253 CPDF_Font* CPDF_DocPageData::GetStandardFont(const CFX_ByteStringC& fontName,
254                                              CPDF_FontEncoding* pEncoding) {
255   if (fontName.IsEmpty())
256     return nullptr;
257
258   for (auto& it : m_FontMap) {
259     CPDF_CountedFont* fontData = it.second;
260     CPDF_Font* pFont = fontData->get();
261     if (!pFont)
262       continue;
263     if (pFont->GetBaseFont() != fontName)
264       continue;
265     if (pFont->IsEmbedded())
266       continue;
267     if (pFont->GetFontType() != PDFFONT_TYPE1)
268       continue;
269     if (pFont->GetFontDict()->KeyExist(FX_BSTRC("Widths")))
270       continue;
271
272     CPDF_Type1Font* pT1Font = pFont->GetType1Font();
273     if (pEncoding && !pT1Font->GetEncoding()->IsIdentical(pEncoding))
274       continue;
275
276     return fontData->AddRef();
277   }
278
279   CPDF_Dictionary* pDict = new CPDF_Dictionary;
280   pDict->SetAtName(FX_BSTRC("Type"), FX_BSTRC("Font"));
281   pDict->SetAtName(FX_BSTRC("Subtype"), FX_BSTRC("Type1"));
282   pDict->SetAtName(FX_BSTRC("BaseFont"), fontName);
283   if (pEncoding) {
284     pDict->SetAt(FX_BSTRC("Encoding"), pEncoding->Realize());
285   }
286   m_pPDFDoc->AddIndirectObject(pDict);
287   CPDF_Font* pFont = CPDF_Font::CreateFontF(m_pPDFDoc, pDict);
288   if (!pFont) {
289     return nullptr;
290   }
291   CPDF_CountedFont* fontData = new CPDF_CountedFont(pFont);
292   m_FontMap[pDict] = fontData;
293   return fontData->AddRef();
294 }
295
296 void CPDF_DocPageData::ReleaseFont(CPDF_Dictionary* pFontDict) {
297   if (!pFontDict)
298     return;
299
300   auto it = m_FontMap.find(pFontDict);
301   if (it == m_FontMap.end())
302     return;
303
304   CPDF_CountedFont* fontData = it->second;
305   if (fontData->get()) {
306     fontData->RemoveRef();
307     if (fontData->use_count() == 0) {
308       fontData->clear();
309     }
310   }
311 }
312
313 CPDF_ColorSpace* CPDF_DocPageData::GetColorSpace(CPDF_Object* pCSObj,
314                                                  CPDF_Dictionary* pResources) {
315   if (!pCSObj) {
316     return NULL;
317   }
318   if (pCSObj->GetType() == PDFOBJ_NAME) {
319     CFX_ByteString name = pCSObj->GetConstString();
320     CPDF_ColorSpace* pCS = _CSFromName(name);
321     if (!pCS && pResources) {
322       CPDF_Dictionary* pList = pResources->GetDict(FX_BSTRC("ColorSpace"));
323       if (pList) {
324         pCSObj = pList->GetElementValue(name);
325         return GetColorSpace(pCSObj, NULL);
326       }
327     }
328     if (pCS == NULL || pResources == NULL) {
329       return pCS;
330     }
331     CPDF_Dictionary* pColorSpaces = pResources->GetDict(FX_BSTRC("ColorSpace"));
332     if (pColorSpaces == NULL) {
333       return pCS;
334     }
335     CPDF_Object* pDefaultCS = NULL;
336     switch (pCS->GetFamily()) {
337       case PDFCS_DEVICERGB:
338         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultRGB"));
339         break;
340       case PDFCS_DEVICEGRAY:
341         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultGray"));
342         break;
343       case PDFCS_DEVICECMYK:
344         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultCMYK"));
345         break;
346     }
347     if (pDefaultCS == NULL) {
348       return pCS;
349     }
350     return GetColorSpace(pDefaultCS, NULL);
351   }
352
353   if (pCSObj->GetType() != PDFOBJ_ARRAY)
354     return nullptr;
355   CPDF_Array* pArray = (CPDF_Array*)pCSObj;
356   if (pArray->GetCount() == 0)
357     return nullptr;
358   if (pArray->GetCount() == 1)
359     return GetColorSpace(pArray->GetElementValue(0), pResources);
360
361   CPDF_CountedColorSpace* csData = nullptr;
362   auto it = m_ColorSpaceMap.find(pCSObj);
363   if (it != m_ColorSpaceMap.end()) {
364     csData = it->second;
365     if (csData->get()) {
366       return csData->AddRef();
367     }
368   }
369
370   CPDF_ColorSpace* pCS = CPDF_ColorSpace::Load(m_pPDFDoc, pArray);
371   if (!pCS)
372     return nullptr;
373
374   if (!csData) {
375     csData = new CPDF_CountedColorSpace(pCS);
376     m_ColorSpaceMap[pCSObj] = csData;
377   } else {
378     csData->reset(pCS);
379   }
380   return csData->AddRef();
381 }
382
383 CPDF_ColorSpace* CPDF_DocPageData::GetCopiedColorSpace(CPDF_Object* pCSObj) {
384   if (!pCSObj)
385     return nullptr;
386
387   auto it = m_ColorSpaceMap.find(pCSObj);
388   if (it != m_ColorSpaceMap.end())
389     return it->second->AddRef();
390
391   return nullptr;
392 }
393
394 void CPDF_DocPageData::ReleaseColorSpace(CPDF_Object* pColorSpace) {
395   if (!pColorSpace)
396     return;
397
398   auto it = m_ColorSpaceMap.find(pColorSpace);
399   if (it == m_ColorSpaceMap.end())
400     return;
401
402   CPDF_CountedColorSpace* csData = it->second;
403   if (csData->get()) {
404     csData->RemoveRef();
405     if (csData->use_count() == 0) {
406       csData->get()->ReleaseCS();
407       csData->reset(nullptr);
408     }
409   }
410 }
411
412 CPDF_Pattern* CPDF_DocPageData::GetPattern(CPDF_Object* pPatternObj,
413                                            FX_BOOL bShading,
414                                            const CFX_AffineMatrix* matrix) {
415   if (!pPatternObj)
416     return nullptr;
417
418   CPDF_CountedPattern* ptData = nullptr;
419   auto it = m_PatternMap.find(pPatternObj);
420   if (it != m_PatternMap.end()) {
421     ptData = it->second;
422     if (ptData->get()) {
423       return ptData->AddRef();
424     }
425   }
426   CPDF_Pattern* pPattern = nullptr;
427   if (bShading) {
428     pPattern =
429         new CPDF_ShadingPattern(m_pPDFDoc, pPatternObj, bShading, matrix);
430   } else {
431     CPDF_Dictionary* pDict = pPatternObj ? pPatternObj->GetDict() : nullptr;
432     if (pDict) {
433       int type = pDict->GetInteger(FX_BSTRC("PatternType"));
434       if (type == 1) {
435         pPattern = new CPDF_TilingPattern(m_pPDFDoc, pPatternObj, matrix);
436       } else if (type == 2) {
437         pPattern =
438             new CPDF_ShadingPattern(m_pPDFDoc, pPatternObj, FALSE, matrix);
439       }
440     }
441   }
442   if (!pPattern)
443     return nullptr;
444
445   if (!ptData) {
446     ptData = new CPDF_CountedPattern(pPattern);
447     m_PatternMap[pPatternObj] = ptData;
448   } else {
449     ptData->reset(pPattern);
450   }
451   return ptData->AddRef();
452 }
453
454 void CPDF_DocPageData::ReleasePattern(CPDF_Object* pPatternObj) {
455   if (!pPatternObj)
456     return;
457
458   auto it = m_PatternMap.find(pPatternObj);
459   if (it == m_PatternMap.end())
460     return;
461
462   CPDF_CountedPattern* ptData = it->second;
463   if (ptData->get()) {
464     ptData->RemoveRef();
465     if (ptData->use_count() == 0) {
466       ptData->clear();
467     }
468   }
469 }
470
471 CPDF_Image* CPDF_DocPageData::GetImage(CPDF_Object* pImageStream) {
472   if (!pImageStream)
473     return nullptr;
474
475   const FX_DWORD dwImageObjNum = pImageStream->GetObjNum();
476   auto it = m_ImageMap.find(dwImageObjNum);
477   if (it != m_ImageMap.end()) {
478     return it->second->AddRef();
479   }
480
481   CPDF_Image* pImage = new CPDF_Image(m_pPDFDoc);
482   pImage->LoadImageF((CPDF_Stream*)pImageStream, FALSE);
483
484   CPDF_CountedImage* imageData = new CPDF_CountedImage(pImage);
485   m_ImageMap[dwImageObjNum] = imageData;
486   return imageData->AddRef();
487 }
488
489 void CPDF_DocPageData::ReleaseImage(CPDF_Object* pImageStream) {
490   if (!pImageStream || !pImageStream->GetObjNum())
491     return;
492
493   auto it = m_ImageMap.find(pImageStream->GetObjNum());
494   if (it == m_ImageMap.end())
495     return;
496
497   CPDF_CountedImage* image = it->second;
498   if (!image)
499     return;
500
501   image->RemoveRef();
502   if (image->use_count() == 0) {
503     delete image->get();
504     delete image;
505     m_ImageMap.erase(it);
506   }
507 }
508
509 CPDF_IccProfile* CPDF_DocPageData::GetIccProfile(
510     CPDF_Stream* pIccProfileStream) {
511   if (!pIccProfileStream)
512     return NULL;
513
514   auto it = m_IccProfileMap.find(pIccProfileStream);
515   if (it != m_IccProfileMap.end()) {
516     return it->second->AddRef();
517   }
518
519   CPDF_StreamAcc stream;
520   stream.LoadAllData(pIccProfileStream, FALSE);
521   uint8_t digest[20];
522   CPDF_Stream* pCopiedStream = nullptr;
523   CRYPT_SHA1Generate(stream.GetData(), stream.GetSize(), digest);
524   if (m_HashProfileMap.Lookup(CFX_ByteStringC(digest, 20),
525                               (void*&)pCopiedStream)) {
526     auto it_copied_stream = m_IccProfileMap.find(pCopiedStream);
527     return it_copied_stream->second->AddRef();
528   }
529   CPDF_IccProfile* pProfile =
530       new CPDF_IccProfile(stream.GetData(), stream.GetSize());
531   CPDF_CountedIccProfile* ipData = new CPDF_CountedIccProfile(pProfile);
532   m_IccProfileMap[pIccProfileStream] = ipData;
533   m_HashProfileMap.SetAt(CFX_ByteStringC(digest, 20), pIccProfileStream);
534   return ipData->AddRef();
535 }
536
537 void CPDF_DocPageData::ReleaseIccProfile(CPDF_IccProfile* pIccProfile) {
538   ASSERT(pIccProfile);
539
540   for (auto it = m_IccProfileMap.begin(); it != m_IccProfileMap.end(); ++it) {
541     CPDF_CountedIccProfile* profile = it->second;
542     if (profile->get() != pIccProfile)
543       continue;
544
545     profile->RemoveRef();
546     if (profile->use_count() == 0) {
547       delete profile->get();
548       delete profile;
549       m_IccProfileMap.erase(it);
550       return;
551     }
552   }
553 }
554
555 CPDF_StreamAcc* CPDF_DocPageData::GetFontFileStreamAcc(
556     CPDF_Stream* pFontStream) {
557   ASSERT(pFontStream);
558
559   auto it = m_FontFileMap.find(pFontStream);
560   if (it != m_FontFileMap.end())
561     return it->second->AddRef();
562
563   CPDF_Dictionary* pFontDict = pFontStream->GetDict();
564   int32_t org_size = pFontDict->GetInteger(FX_BSTRC("Length1")) +
565                      pFontDict->GetInteger(FX_BSTRC("Length2")) +
566                      pFontDict->GetInteger(FX_BSTRC("Length3"));
567   if (org_size < 0)
568     org_size = 0;
569
570   CPDF_StreamAcc* pFontFile = new CPDF_StreamAcc;
571   pFontFile->LoadAllData(pFontStream, FALSE, org_size);
572
573   CPDF_CountedStreamAcc* ftData = new CPDF_CountedStreamAcc(pFontFile);
574   m_FontFileMap[pFontStream] = ftData;
575   return ftData->AddRef();
576 }
577
578 void CPDF_DocPageData::ReleaseFontFileStreamAcc(CPDF_Stream* pFontStream,
579                                                 FX_BOOL bForce) {
580   if (!pFontStream)
581     return;
582
583   auto it = m_FontFileMap.find(pFontStream);
584   if (it == m_FontFileMap.end())
585     return;
586
587   CPDF_CountedStreamAcc* findData = it->second;
588   if (!findData)
589     return;
590
591   findData->RemoveRef();
592   if (findData->use_count() == 0 || bForce) {
593     delete findData->get();
594     delete findData;
595     m_FontFileMap.erase(it);
596   }
597 }
598
599 CPDF_CountedColorSpace* CPDF_DocPageData::FindColorSpacePtr(
600     CPDF_Object* pCSObj) const {
601   if (!pCSObj)
602     return nullptr;
603
604   auto it = m_ColorSpaceMap.find(pCSObj);
605   return it != m_ColorSpaceMap.end() ? it->second : nullptr;
606 }
607
608 CPDF_CountedPattern* CPDF_DocPageData::FindPatternPtr(
609     CPDF_Object* pPatternObj) const {
610   if (!pPatternObj)
611     return nullptr;
612
613   auto it = m_PatternMap.find(pPatternObj);
614   return it != m_PatternMap.end() ? it->second : nullptr;
615 }