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