CFX_MapByteStringToPtr considered harmful.
[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       for (auto hash_it = m_HashProfileMap.begin();
175            hash_it != m_HashProfileMap.end(); ++hash_it) {
176         if (curr_it->first == hash_it->second) {
177           m_HashProfileMap.erase(hash_it);
178           break;
179         }
180       }
181       delete ipData->get();
182       delete ipData;
183       m_IccProfileMap.erase(curr_it);
184     }
185   }
186
187   for (auto it = m_FontFileMap.begin(); it != m_FontFileMap.end();) {
188     auto curr_it = it++;
189     CPDF_CountedStreamAcc* ftData = curr_it->second;
190     if (!ftData->get())
191       continue;
192
193     if (bForceRelease || ftData->use_count() < 2) {
194       delete ftData->get();
195       delete ftData;
196       m_FontFileMap.erase(curr_it);
197     }
198   }
199
200   for (auto it = m_ImageMap.begin(); it != m_ImageMap.end();) {
201     auto curr_it = it++;
202     CPDF_CountedImage* imageData = curr_it->second;
203     if (!imageData->get())
204       continue;
205
206     if (bForceRelease || imageData->use_count() < 2) {
207       delete imageData->get();
208       delete imageData;
209       m_ImageMap.erase(curr_it);
210     }
211   }
212 }
213
214 CPDF_Font* CPDF_DocPageData::GetFont(CPDF_Dictionary* pFontDict,
215                                      FX_BOOL findOnly) {
216   if (!pFontDict) {
217     return NULL;
218   }
219   if (findOnly) {
220     auto it = m_FontMap.find(pFontDict);
221     if (it != m_FontMap.end() && it->second->get()) {
222       return it->second->AddRef();
223     }
224     return nullptr;
225   }
226
227   CPDF_CountedFont* fontData = nullptr;
228   auto it = m_FontMap.find(pFontDict);
229   if (it != m_FontMap.end()) {
230     fontData = it->second;
231     if (fontData->get()) {
232       return fontData->AddRef();
233     }
234   }
235
236   CPDF_Font* pFont = CPDF_Font::CreateFontF(m_pPDFDoc, pFontDict);
237   if (!pFont) {
238     return nullptr;
239   }
240   if (!fontData) {
241     fontData = new CPDF_CountedFont(pFont);
242     m_FontMap[pFontDict] = fontData;
243   } else {
244     fontData->reset(pFont);
245   }
246   return fontData->AddRef();
247 }
248
249 CPDF_Font* CPDF_DocPageData::GetStandardFont(const CFX_ByteStringC& fontName,
250                                              CPDF_FontEncoding* pEncoding) {
251   if (fontName.IsEmpty())
252     return nullptr;
253
254   for (auto& it : m_FontMap) {
255     CPDF_CountedFont* fontData = it.second;
256     CPDF_Font* pFont = fontData->get();
257     if (!pFont)
258       continue;
259     if (pFont->GetBaseFont() != fontName)
260       continue;
261     if (pFont->IsEmbedded())
262       continue;
263     if (pFont->GetFontType() != PDFFONT_TYPE1)
264       continue;
265     if (pFont->GetFontDict()->KeyExist(FX_BSTRC("Widths")))
266       continue;
267
268     CPDF_Type1Font* pT1Font = pFont->GetType1Font();
269     if (pEncoding && !pT1Font->GetEncoding()->IsIdentical(pEncoding))
270       continue;
271
272     return fontData->AddRef();
273   }
274
275   CPDF_Dictionary* pDict = new CPDF_Dictionary;
276   pDict->SetAtName(FX_BSTRC("Type"), FX_BSTRC("Font"));
277   pDict->SetAtName(FX_BSTRC("Subtype"), FX_BSTRC("Type1"));
278   pDict->SetAtName(FX_BSTRC("BaseFont"), fontName);
279   if (pEncoding) {
280     pDict->SetAt(FX_BSTRC("Encoding"), pEncoding->Realize());
281   }
282   m_pPDFDoc->AddIndirectObject(pDict);
283   CPDF_Font* pFont = CPDF_Font::CreateFontF(m_pPDFDoc, pDict);
284   if (!pFont) {
285     return nullptr;
286   }
287   CPDF_CountedFont* fontData = new CPDF_CountedFont(pFont);
288   m_FontMap[pDict] = fontData;
289   return fontData->AddRef();
290 }
291
292 void CPDF_DocPageData::ReleaseFont(CPDF_Dictionary* pFontDict) {
293   if (!pFontDict)
294     return;
295
296   auto it = m_FontMap.find(pFontDict);
297   if (it == m_FontMap.end())
298     return;
299
300   CPDF_CountedFont* fontData = it->second;
301   if (fontData->get()) {
302     fontData->RemoveRef();
303     if (fontData->use_count() == 0) {
304       fontData->clear();
305     }
306   }
307 }
308
309 CPDF_ColorSpace* CPDF_DocPageData::GetColorSpace(CPDF_Object* pCSObj,
310                                                  CPDF_Dictionary* pResources) {
311   if (!pCSObj) {
312     return NULL;
313   }
314   if (pCSObj->GetType() == PDFOBJ_NAME) {
315     CFX_ByteString name = pCSObj->GetConstString();
316     CPDF_ColorSpace* pCS = _CSFromName(name);
317     if (!pCS && pResources) {
318       CPDF_Dictionary* pList = pResources->GetDict(FX_BSTRC("ColorSpace"));
319       if (pList) {
320         pCSObj = pList->GetElementValue(name);
321         return GetColorSpace(pCSObj, NULL);
322       }
323     }
324     if (pCS == NULL || pResources == NULL) {
325       return pCS;
326     }
327     CPDF_Dictionary* pColorSpaces = pResources->GetDict(FX_BSTRC("ColorSpace"));
328     if (pColorSpaces == NULL) {
329       return pCS;
330     }
331     CPDF_Object* pDefaultCS = NULL;
332     switch (pCS->GetFamily()) {
333       case PDFCS_DEVICERGB:
334         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultRGB"));
335         break;
336       case PDFCS_DEVICEGRAY:
337         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultGray"));
338         break;
339       case PDFCS_DEVICECMYK:
340         pDefaultCS = pColorSpaces->GetElementValue(FX_BSTRC("DefaultCMYK"));
341         break;
342     }
343     if (pDefaultCS == NULL) {
344       return pCS;
345     }
346     return GetColorSpace(pDefaultCS, NULL);
347   }
348
349   if (pCSObj->GetType() != PDFOBJ_ARRAY)
350     return nullptr;
351   CPDF_Array* pArray = (CPDF_Array*)pCSObj;
352   if (pArray->GetCount() == 0)
353     return nullptr;
354   if (pArray->GetCount() == 1)
355     return GetColorSpace(pArray->GetElementValue(0), pResources);
356
357   CPDF_CountedColorSpace* csData = nullptr;
358   auto it = m_ColorSpaceMap.find(pCSObj);
359   if (it != m_ColorSpaceMap.end()) {
360     csData = it->second;
361     if (csData->get()) {
362       return csData->AddRef();
363     }
364   }
365
366   CPDF_ColorSpace* pCS = CPDF_ColorSpace::Load(m_pPDFDoc, pArray);
367   if (!pCS)
368     return nullptr;
369
370   if (!csData) {
371     csData = new CPDF_CountedColorSpace(pCS);
372     m_ColorSpaceMap[pCSObj] = csData;
373   } else {
374     csData->reset(pCS);
375   }
376   return csData->AddRef();
377 }
378
379 CPDF_ColorSpace* CPDF_DocPageData::GetCopiedColorSpace(CPDF_Object* pCSObj) {
380   if (!pCSObj)
381     return nullptr;
382
383   auto it = m_ColorSpaceMap.find(pCSObj);
384   if (it != m_ColorSpaceMap.end())
385     return it->second->AddRef();
386
387   return nullptr;
388 }
389
390 void CPDF_DocPageData::ReleaseColorSpace(CPDF_Object* pColorSpace) {
391   if (!pColorSpace)
392     return;
393
394   auto it = m_ColorSpaceMap.find(pColorSpace);
395   if (it == m_ColorSpaceMap.end())
396     return;
397
398   CPDF_CountedColorSpace* csData = it->second;
399   if (csData->get()) {
400     csData->RemoveRef();
401     if (csData->use_count() == 0) {
402       csData->get()->ReleaseCS();
403       csData->reset(nullptr);
404     }
405   }
406 }
407
408 CPDF_Pattern* CPDF_DocPageData::GetPattern(CPDF_Object* pPatternObj,
409                                            FX_BOOL bShading,
410                                            const CFX_AffineMatrix* matrix) {
411   if (!pPatternObj)
412     return nullptr;
413
414   CPDF_CountedPattern* ptData = nullptr;
415   auto it = m_PatternMap.find(pPatternObj);
416   if (it != m_PatternMap.end()) {
417     ptData = it->second;
418     if (ptData->get()) {
419       return ptData->AddRef();
420     }
421   }
422   CPDF_Pattern* pPattern = nullptr;
423   if (bShading) {
424     pPattern =
425         new CPDF_ShadingPattern(m_pPDFDoc, pPatternObj, bShading, matrix);
426   } else {
427     CPDF_Dictionary* pDict = pPatternObj ? pPatternObj->GetDict() : nullptr;
428     if (pDict) {
429       int type = pDict->GetInteger(FX_BSTRC("PatternType"));
430       if (type == 1) {
431         pPattern = new CPDF_TilingPattern(m_pPDFDoc, pPatternObj, matrix);
432       } else if (type == 2) {
433         pPattern =
434             new CPDF_ShadingPattern(m_pPDFDoc, pPatternObj, FALSE, matrix);
435       }
436     }
437   }
438   if (!pPattern)
439     return nullptr;
440
441   if (!ptData) {
442     ptData = new CPDF_CountedPattern(pPattern);
443     m_PatternMap[pPatternObj] = ptData;
444   } else {
445     ptData->reset(pPattern);
446   }
447   return ptData->AddRef();
448 }
449
450 void CPDF_DocPageData::ReleasePattern(CPDF_Object* pPatternObj) {
451   if (!pPatternObj)
452     return;
453
454   auto it = m_PatternMap.find(pPatternObj);
455   if (it == m_PatternMap.end())
456     return;
457
458   CPDF_CountedPattern* ptData = it->second;
459   if (ptData->get()) {
460     ptData->RemoveRef();
461     if (ptData->use_count() == 0) {
462       ptData->clear();
463     }
464   }
465 }
466
467 CPDF_Image* CPDF_DocPageData::GetImage(CPDF_Object* pImageStream) {
468   if (!pImageStream)
469     return nullptr;
470
471   const FX_DWORD dwImageObjNum = pImageStream->GetObjNum();
472   auto it = m_ImageMap.find(dwImageObjNum);
473   if (it != m_ImageMap.end()) {
474     return it->second->AddRef();
475   }
476
477   CPDF_Image* pImage = new CPDF_Image(m_pPDFDoc);
478   pImage->LoadImageF((CPDF_Stream*)pImageStream, FALSE);
479
480   CPDF_CountedImage* imageData = new CPDF_CountedImage(pImage);
481   m_ImageMap[dwImageObjNum] = imageData;
482   return imageData->AddRef();
483 }
484
485 void CPDF_DocPageData::ReleaseImage(CPDF_Object* pImageStream) {
486   if (!pImageStream || !pImageStream->GetObjNum())
487     return;
488
489   auto it = m_ImageMap.find(pImageStream->GetObjNum());
490   if (it == m_ImageMap.end())
491     return;
492
493   CPDF_CountedImage* image = it->second;
494   if (!image)
495     return;
496
497   image->RemoveRef();
498   if (image->use_count() == 0) {
499     delete image->get();
500     delete image;
501     m_ImageMap.erase(it);
502   }
503 }
504
505 CPDF_IccProfile* CPDF_DocPageData::GetIccProfile(
506     CPDF_Stream* pIccProfileStream) {
507   if (!pIccProfileStream)
508     return NULL;
509
510   auto it = m_IccProfileMap.find(pIccProfileStream);
511   if (it != m_IccProfileMap.end()) {
512     return it->second->AddRef();
513   }
514
515   CPDF_StreamAcc stream;
516   stream.LoadAllData(pIccProfileStream, FALSE);
517   uint8_t digest[20];
518   CRYPT_SHA1Generate(stream.GetData(), stream.GetSize(), digest);
519   auto hash_it = m_HashProfileMap.find(CFX_ByteStringC(digest, 20));
520   if (hash_it != m_HashProfileMap.end()) {
521     auto it_copied_stream = m_IccProfileMap.find(hash_it->second);
522     return it_copied_stream->second->AddRef();
523   }
524   CPDF_IccProfile* pProfile =
525       new CPDF_IccProfile(stream.GetData(), stream.GetSize());
526   CPDF_CountedIccProfile* ipData = new CPDF_CountedIccProfile(pProfile);
527   m_IccProfileMap[pIccProfileStream] = ipData;
528   m_HashProfileMap[CFX_ByteStringC(digest, 20)] = pIccProfileStream;
529   return ipData->AddRef();
530 }
531
532 void CPDF_DocPageData::ReleaseIccProfile(CPDF_IccProfile* pIccProfile) {
533   ASSERT(pIccProfile);
534
535   for (auto it = m_IccProfileMap.begin(); it != m_IccProfileMap.end(); ++it) {
536     CPDF_CountedIccProfile* profile = it->second;
537     if (profile->get() != pIccProfile)
538       continue;
539
540     profile->RemoveRef();
541     if (profile->use_count() == 0) {
542       delete profile->get();
543       delete profile;
544       m_IccProfileMap.erase(it);
545       return;
546     }
547   }
548 }
549
550 CPDF_StreamAcc* CPDF_DocPageData::GetFontFileStreamAcc(
551     CPDF_Stream* pFontStream) {
552   ASSERT(pFontStream);
553
554   auto it = m_FontFileMap.find(pFontStream);
555   if (it != m_FontFileMap.end())
556     return it->second->AddRef();
557
558   CPDF_Dictionary* pFontDict = pFontStream->GetDict();
559   int32_t org_size = pFontDict->GetInteger(FX_BSTRC("Length1")) +
560                      pFontDict->GetInteger(FX_BSTRC("Length2")) +
561                      pFontDict->GetInteger(FX_BSTRC("Length3"));
562   if (org_size < 0)
563     org_size = 0;
564
565   CPDF_StreamAcc* pFontFile = new CPDF_StreamAcc;
566   pFontFile->LoadAllData(pFontStream, FALSE, org_size);
567
568   CPDF_CountedStreamAcc* ftData = new CPDF_CountedStreamAcc(pFontFile);
569   m_FontFileMap[pFontStream] = ftData;
570   return ftData->AddRef();
571 }
572
573 void CPDF_DocPageData::ReleaseFontFileStreamAcc(CPDF_Stream* pFontStream,
574                                                 FX_BOOL bForce) {
575   if (!pFontStream)
576     return;
577
578   auto it = m_FontFileMap.find(pFontStream);
579   if (it == m_FontFileMap.end())
580     return;
581
582   CPDF_CountedStreamAcc* findData = it->second;
583   if (!findData)
584     return;
585
586   findData->RemoveRef();
587   if (findData->use_count() == 0 || bForce) {
588     delete findData->get();
589     delete findData;
590     m_FontFileMap.erase(it);
591   }
592 }
593
594 CPDF_CountedColorSpace* CPDF_DocPageData::FindColorSpacePtr(
595     CPDF_Object* pCSObj) const {
596   if (!pCSObj)
597     return nullptr;
598
599   auto it = m_ColorSpaceMap.find(pCSObj);
600   return it != m_ColorSpaceMap.end() ? it->second : nullptr;
601 }
602
603 CPDF_CountedPattern* CPDF_DocPageData::FindPatternPtr(
604     CPDF_Object* pPatternObj) const {
605   if (!pPatternObj)
606     return nullptr;
607
608   auto it = m_PatternMap.find(pPatternObj);
609   return it != m_PatternMap.end() ? it->second : nullptr;
610 }