Cleanup some numeric code.
[pdfium.git] / fpdfsdk / src / fpdf_flatten.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_flatten.h"
8 #include "../include/fsdk_define.h"
9
10 typedef CFX_ArrayTemplate<CPDF_Dictionary*> CPDF_ObjectArray;
11 typedef CFX_ArrayTemplate<CPDF_Rect> CPDF_RectArray;
12
13 enum FPDF_TYPE { MAX, MIN };
14 enum FPDF_VALUE { TOP, LEFT, RIGHT, BOTTOM };
15
16 FX_BOOL IsValiableRect(CPDF_Rect rect, CPDF_Rect rcPage) {
17   if (rect.left - rect.right > 0.000001f || rect.bottom - rect.top > 0.000001f)
18     return FALSE;
19
20   if (rect.left == 0.0f && rect.top == 0.0f && rect.right == 0.0f &&
21       rect.bottom == 0.0f)
22     return FALSE;
23
24   if (!rcPage.IsEmpty()) {
25     if (rect.left - rcPage.left < -10.000001f ||
26         rect.right - rcPage.right > 10.000001f ||
27         rect.top - rcPage.top > 10.000001f ||
28         rect.bottom - rcPage.bottom < -10.000001f)
29       return FALSE;
30   }
31
32   return TRUE;
33 }
34
35 FX_BOOL GetContentsRect(CPDF_Document* pDoc,
36                         CPDF_Dictionary* pDict,
37                         CPDF_RectArray* pRectArray) {
38   CPDF_Page* pPDFPage = new CPDF_Page;
39   pPDFPage->Load(pDoc, pDict, FALSE);
40   pPDFPage->ParseContent();
41
42   FX_POSITION pos = pPDFPage->GetFirstObjectPosition();
43
44   while (pos) {
45     CPDF_PageObject* pPageObject = pPDFPage->GetNextObject(pos);
46     if (!pPageObject)
47       continue;
48
49     CPDF_Rect rc;
50     rc.left = pPageObject->m_Left;
51     rc.right = pPageObject->m_Right;
52     rc.bottom = pPageObject->m_Bottom;
53     rc.top = pPageObject->m_Top;
54
55     if (IsValiableRect(rc, pDict->GetRect("MediaBox"))) {
56       pRectArray->Add(rc);
57     }
58   }
59
60   delete pPDFPage;
61   return TRUE;
62 }
63
64 void ParserStream(CPDF_Dictionary* pPageDic,
65                   CPDF_Dictionary* pStream,
66                   CPDF_RectArray* pRectArray,
67                   CPDF_ObjectArray* pObjectArray) {
68   if (!pStream)
69     return;
70   CPDF_Rect rect;
71   if (pStream->KeyExist("Rect"))
72     rect = pStream->GetRect("Rect");
73   else if (pStream->KeyExist("BBox"))
74     rect = pStream->GetRect("BBox");
75
76   if (IsValiableRect(rect, pPageDic->GetRect("MediaBox")))
77     pRectArray->Add(rect);
78
79   pObjectArray->Add(pStream);
80 }
81
82 int ParserAnnots(CPDF_Document* pSourceDoc,
83                  CPDF_Dictionary* pPageDic,
84                  CPDF_RectArray* pRectArray,
85                  CPDF_ObjectArray* pObjectArray,
86                  int nUsage) {
87   if (!pSourceDoc || !pPageDic)
88     return FLATTEN_FAIL;
89
90   GetContentsRect(pSourceDoc, pPageDic, pRectArray);
91   CPDF_Array* pAnnots = pPageDic->GetArray("Annots");
92   if (!pAnnots)
93     return FLATTEN_NOTHINGTODO;
94
95   FX_DWORD dwSize = pAnnots->GetCount();
96   for (int i = 0; i < (int)dwSize; i++) {
97     CPDF_Dictionary* pAnnotDic = ToDictionary(pAnnots->GetElementValue(i));
98     if (!pAnnotDic)
99       continue;
100
101     CFX_ByteString sSubtype = pAnnotDic->GetString("Subtype");
102     if (sSubtype == "Popup")
103       continue;
104
105     int nAnnotFlag = pAnnotDic->GetInteger("F");
106     if (nAnnotFlag & ANNOTFLAG_HIDDEN)
107       continue;
108
109     if (nUsage == FLAT_NORMALDISPLAY) {
110       if (nAnnotFlag & ANNOTFLAG_INVISIBLE)
111         continue;
112
113       ParserStream(pPageDic, pAnnotDic, pRectArray, pObjectArray);
114     } else {
115       if (nAnnotFlag & ANNOTFLAG_PRINT)
116         ParserStream(pPageDic, pAnnotDic, pRectArray, pObjectArray);
117     }
118   }
119   return FLATTEN_SUCCESS;
120 }
121
122 FX_FLOAT GetMinMaxValue(CPDF_RectArray& array,
123                         FPDF_TYPE type,
124                         FPDF_VALUE value) {
125   int nRects = array.GetSize();
126   FX_FLOAT fRet = 0.0f;
127
128   if (nRects <= 0)
129     return 0.0f;
130
131   FX_FLOAT* pArray = new FX_FLOAT[nRects];
132   switch (value) {
133     case LEFT: {
134       for (int i = 0; i < nRects; i++)
135         pArray[i] = CPDF_Rect(array.GetAt(i)).left;
136
137       break;
138     }
139     case TOP: {
140       for (int i = 0; i < nRects; i++)
141         pArray[i] = CPDF_Rect(array.GetAt(i)).top;
142
143       break;
144     }
145     case RIGHT: {
146       for (int i = 0; i < nRects; i++)
147         pArray[i] = CPDF_Rect(array.GetAt(i)).right;
148
149       break;
150     }
151     case BOTTOM: {
152       for (int i = 0; i < nRects; i++)
153         pArray[i] = CPDF_Rect(array.GetAt(i)).bottom;
154
155       break;
156     }
157     default:
158       break;
159   }
160   fRet = pArray[0];
161   if (type == MAX) {
162     for (int i = 1; i < nRects; i++)
163       if (fRet <= pArray[i])
164         fRet = pArray[i];
165   } else {
166     for (int i = 1; i < nRects; i++)
167       if (fRet >= pArray[i])
168         fRet = pArray[i];
169   }
170   delete[] pArray;
171   return fRet;
172 }
173
174 CPDF_Rect CalculateRect(CPDF_RectArray* pRectArray) {
175   CPDF_Rect rcRet;
176
177   rcRet.left = GetMinMaxValue(*pRectArray, MIN, LEFT);
178   rcRet.top = GetMinMaxValue(*pRectArray, MAX, TOP);
179   rcRet.right = GetMinMaxValue(*pRectArray, MAX, RIGHT);
180   rcRet.bottom = GetMinMaxValue(*pRectArray, MIN, BOTTOM);
181
182   return rcRet;
183 }
184
185 void SetPageContents(CFX_ByteString key,
186                      CPDF_Dictionary* pPage,
187                      CPDF_Document* pDocument) {
188   CPDF_Object* pContentsObj = pPage->GetStream("Contents");
189   if (!pContentsObj) {
190     pContentsObj = pPage->GetArray("Contents");
191   }
192
193   if (!pContentsObj) {
194     // Create a new contents dictionary
195     if (!key.IsEmpty()) {
196       CPDF_Stream* pNewContents = new CPDF_Stream(NULL, 0, new CPDF_Dictionary);
197       pPage->SetAtReference("Contents", pDocument,
198                             pDocument->AddIndirectObject(pNewContents));
199
200       CFX_ByteString sStream;
201       sStream.Format("q 1 0 0 1 0 0 cm /%s Do Q", key.c_str());
202       pNewContents->SetData((const uint8_t*)sStream, sStream.GetLength(), FALSE,
203                             FALSE);
204     }
205     return;
206   }
207
208   int iType = pContentsObj->GetType();
209   CPDF_Array* pContentsArray = NULL;
210
211   switch (iType) {
212     case PDFOBJ_STREAM: {
213       pContentsArray = new CPDF_Array;
214       CPDF_Stream* pContents = pContentsObj->AsStream();
215       FX_DWORD dwObjNum = pDocument->AddIndirectObject(pContents);
216       CPDF_StreamAcc acc;
217       acc.LoadAllData(pContents);
218       CFX_ByteString sStream = "q\n";
219       CFX_ByteString sBody =
220           CFX_ByteString((const FX_CHAR*)acc.GetData(), acc.GetSize());
221       sStream = sStream + sBody + "\nQ";
222       pContents->SetData((const uint8_t*)sStream, sStream.GetLength(), FALSE,
223                          FALSE);
224       pContentsArray->AddReference(pDocument, dwObjNum);
225       break;
226     }
227
228     case PDFOBJ_ARRAY: {
229       pContentsArray = pContentsObj->AsArray();
230       break;
231     }
232     default:
233       break;
234   }
235
236   if (!pContentsArray)
237     return;
238
239   FX_DWORD dwObjNum = pDocument->AddIndirectObject(pContentsArray);
240   pPage->SetAtReference("Contents", pDocument, dwObjNum);
241
242   if (!key.IsEmpty()) {
243     CPDF_Stream* pNewContents = new CPDF_Stream(NULL, 0, new CPDF_Dictionary);
244     dwObjNum = pDocument->AddIndirectObject(pNewContents);
245     pContentsArray->AddReference(pDocument, dwObjNum);
246
247     CFX_ByteString sStream;
248     sStream.Format("q 1 0 0 1 0 0 cm /%s Do Q", key.c_str());
249     pNewContents->SetData((const uint8_t*)sStream, sStream.GetLength(), FALSE,
250                           FALSE);
251   }
252 }
253
254 CFX_AffineMatrix GetMatrix(CPDF_Rect rcAnnot,
255                            CPDF_Rect rcStream,
256                            CFX_AffineMatrix matrix) {
257   if (rcStream.IsEmpty())
258     return CFX_AffineMatrix();
259
260   matrix.TransformRect(rcStream);
261   rcStream.Normalize();
262
263   FX_FLOAT a = rcAnnot.Width() / rcStream.Width();
264   FX_FLOAT d = rcAnnot.Height() / rcStream.Height();
265
266   FX_FLOAT e = rcAnnot.left - rcStream.left * a;
267   FX_FLOAT f = rcAnnot.bottom - rcStream.bottom * d;
268   return CFX_AffineMatrix(a, 0, 0, d, e, f);
269 }
270
271 void GetOffset(FX_FLOAT& fa,
272                FX_FLOAT& fd,
273                FX_FLOAT& fe,
274                FX_FLOAT& ff,
275                CPDF_Rect rcAnnot,
276                CPDF_Rect rcStream,
277                CFX_AffineMatrix matrix) {
278   FX_FLOAT fStreamWidth = 0.0f;
279   FX_FLOAT fStreamHeight = 0.0f;
280
281   if (matrix.a != 0 && matrix.d != 0) {
282     fStreamWidth = rcStream.right - rcStream.left;
283     fStreamHeight = rcStream.top - rcStream.bottom;
284   } else {
285     fStreamWidth = rcStream.top - rcStream.bottom;
286     fStreamHeight = rcStream.right - rcStream.left;
287   }
288
289   FX_FLOAT x1 =
290       matrix.a * rcStream.left + matrix.c * rcStream.bottom + matrix.e;
291   FX_FLOAT y1 =
292       matrix.b * rcStream.left + matrix.d * rcStream.bottom + matrix.f;
293   FX_FLOAT x2 = matrix.a * rcStream.left + matrix.c * rcStream.top + matrix.e;
294   FX_FLOAT y2 = matrix.b * rcStream.left + matrix.d * rcStream.top + matrix.f;
295   FX_FLOAT x3 =
296       matrix.a * rcStream.right + matrix.c * rcStream.bottom + matrix.e;
297   FX_FLOAT y3 =
298       matrix.b * rcStream.right + matrix.d * rcStream.bottom + matrix.f;
299   FX_FLOAT x4 = matrix.a * rcStream.right + matrix.c * rcStream.top + matrix.e;
300   FX_FLOAT y4 = matrix.b * rcStream.right + matrix.d * rcStream.top + matrix.f;
301
302   FX_FLOAT left = FX_MIN(FX_MIN(x1, x2), FX_MIN(x3, x4));
303   FX_FLOAT bottom = FX_MIN(FX_MIN(y1, y2), FX_MIN(y3, y4));
304
305   fa = (rcAnnot.right - rcAnnot.left) / fStreamWidth;
306   fd = (rcAnnot.top - rcAnnot.bottom) / fStreamHeight;
307   fe = rcAnnot.left - left * fa;
308   ff = rcAnnot.bottom - bottom * fd;
309 }
310
311 DLLEXPORT int STDCALL FPDFPage_Flatten(FPDF_PAGE page, int nFlag) {
312   CPDF_Page* pPage = CPDFPageFromFPDFPage(page);
313   if (!page) {
314     return FLATTEN_FAIL;
315   }
316
317   CPDF_Document* pDocument = pPage->m_pDocument;
318   CPDF_Dictionary* pPageDict = pPage->m_pFormDict;
319
320   if (!pDocument || !pPageDict) {
321     return FLATTEN_FAIL;
322   }
323
324   CPDF_ObjectArray ObjectArray;
325   CPDF_RectArray RectArray;
326
327   int iRet = FLATTEN_FAIL;
328   iRet = ParserAnnots(pDocument, pPageDict, &RectArray, &ObjectArray, nFlag);
329   if (iRet == FLATTEN_NOTHINGTODO || iRet == FLATTEN_FAIL)
330     return iRet;
331
332   CPDF_Rect rcOriginalCB;
333   CPDF_Rect rcMerger = CalculateRect(&RectArray);
334   CPDF_Rect rcOriginalMB = pPageDict->GetRect("MediaBox");
335
336   if (pPageDict->KeyExist("CropBox"))
337     rcOriginalMB = pPageDict->GetRect("CropBox");
338
339   if (rcOriginalMB.IsEmpty()) {
340     rcOriginalMB = CPDF_Rect(0.0f, 0.0f, 612.0f, 792.0f);
341   }
342
343   rcMerger.left =
344       rcMerger.left < rcOriginalMB.left ? rcOriginalMB.left : rcMerger.left;
345   rcMerger.right =
346       rcMerger.right > rcOriginalMB.right ? rcOriginalMB.right : rcMerger.right;
347   rcMerger.top =
348       rcMerger.top > rcOriginalMB.top ? rcOriginalMB.top : rcMerger.top;
349   rcMerger.bottom = rcMerger.bottom < rcOriginalMB.bottom ? rcOriginalMB.bottom
350                                                           : rcMerger.bottom;
351
352   if (pPageDict->KeyExist("ArtBox"))
353     rcOriginalCB = pPageDict->GetRect("ArtBox");
354   else
355     rcOriginalCB = rcOriginalMB;
356
357   if (!rcOriginalMB.IsEmpty()) {
358     CPDF_Array* pMediaBox = new CPDF_Array();
359     pMediaBox->Add(new CPDF_Number(rcOriginalMB.left));
360     pMediaBox->Add(new CPDF_Number(rcOriginalMB.bottom));
361     pMediaBox->Add(new CPDF_Number(rcOriginalMB.right));
362     pMediaBox->Add(new CPDF_Number(rcOriginalMB.top));
363     pPageDict->SetAt("MediaBox", pMediaBox);
364   }
365
366   if (!rcOriginalCB.IsEmpty()) {
367     CPDF_Array* pCropBox = new CPDF_Array();
368     pCropBox->Add(new CPDF_Number(rcOriginalCB.left));
369     pCropBox->Add(new CPDF_Number(rcOriginalCB.bottom));
370     pCropBox->Add(new CPDF_Number(rcOriginalCB.right));
371     pCropBox->Add(new CPDF_Number(rcOriginalCB.top));
372     pPageDict->SetAt("ArtBox", pCropBox);
373   }
374
375   CPDF_Dictionary* pRes = pPageDict->GetDict("Resources");
376   if (!pRes) {
377     pRes = new CPDF_Dictionary;
378     pPageDict->SetAt("Resources", pRes);
379   }
380
381   CPDF_Stream* pNewXObject = new CPDF_Stream(NULL, 0, new CPDF_Dictionary);
382   FX_DWORD dwObjNum = pDocument->AddIndirectObject(pNewXObject);
383   CPDF_Dictionary* pPageXObject = pRes->GetDict("XObject");
384   if (!pPageXObject) {
385     pPageXObject = new CPDF_Dictionary;
386     pRes->SetAt("XObject", pPageXObject);
387   }
388
389   CFX_ByteString key = "";
390   int nStreams = ObjectArray.GetSize();
391
392   if (nStreams > 0) {
393     for (int iKey = 0; /*iKey < 100*/; iKey++) {
394       char sExtend[5] = {};
395       FXSYS_itoa(iKey, sExtend, 10);
396       key = CFX_ByteString("FFT") + CFX_ByteString(sExtend);
397
398       if (!pPageXObject->KeyExist(key))
399         break;
400     }
401   }
402
403   SetPageContents(key, pPageDict, pDocument);
404
405   CPDF_Dictionary* pNewXORes = NULL;
406
407   if (!key.IsEmpty()) {
408     pPageXObject->SetAtReference(key, pDocument, dwObjNum);
409     CPDF_Dictionary* pNewOXbjectDic = pNewXObject->GetDict();
410     pNewXORes = new CPDF_Dictionary;
411     pNewOXbjectDic->SetAt("Resources", pNewXORes);
412     pNewOXbjectDic->SetAtName("Type", "XObject");
413     pNewOXbjectDic->SetAtName("Subtype", "Form");
414     pNewOXbjectDic->SetAtInteger("FormType", 1);
415     pNewOXbjectDic->SetAtName("Name", "FRM");
416     CPDF_Rect rcBBox = pPageDict->GetRect("ArtBox");
417     pNewOXbjectDic->SetAtRect("BBox", rcBBox);
418   }
419
420   for (int i = 0; i < nStreams; i++) {
421     CPDF_Dictionary* pAnnotDic = ObjectArray.GetAt(i);
422     if (!pAnnotDic)
423       continue;
424
425     CPDF_Rect rcAnnot = pAnnotDic->GetRect("Rect");
426     rcAnnot.Normalize();
427
428     CFX_ByteString sAnnotState = pAnnotDic->GetString("AS");
429     CPDF_Dictionary* pAnnotAP = pAnnotDic->GetDict("AP");
430     if (!pAnnotAP)
431       continue;
432
433     CPDF_Stream* pAPStream = pAnnotAP->GetStream("N");
434     if (!pAPStream) {
435       CPDF_Dictionary* pAPDic = pAnnotAP->GetDict("N");
436       if (!pAPDic)
437         continue;
438
439       if (!sAnnotState.IsEmpty()) {
440         pAPStream = pAPDic->GetStream(sAnnotState);
441       } else {
442         FX_POSITION pos = pAPDic->GetStartPos();
443         if (pos) {
444           CFX_ByteString sKey;
445           CPDF_Object* pFirstObj = pAPDic->GetNextElement(pos, sKey);
446           if (pFirstObj) {
447             if (pFirstObj->IsReference())
448               pFirstObj = pFirstObj->GetDirect();
449             if (!pFirstObj->IsStream())
450               continue;
451             pAPStream = pFirstObj->AsStream();
452           }
453         }
454       }
455     }
456     if (!pAPStream)
457       continue;
458
459     CPDF_Dictionary* pAPDic = pAPStream->GetDict();
460     CFX_AffineMatrix matrix = pAPDic->GetMatrix("Matrix");
461
462     CPDF_Rect rcStream;
463     if (pAPDic->KeyExist("Rect"))
464       rcStream = pAPDic->GetRect("Rect");
465     else if (pAPDic->KeyExist("BBox"))
466       rcStream = pAPDic->GetRect("BBox");
467
468     if (rcStream.IsEmpty())
469       continue;
470
471     CPDF_Object* pObj = pAPStream;
472
473     if (pObj) {
474       CPDF_Dictionary* pObjDic = pObj->GetDict();
475       if (pObjDic) {
476         pObjDic->SetAtName("Type", "XObject");
477         pObjDic->SetAtName("Subtype", "Form");
478       }
479     }
480
481     CPDF_Dictionary* pXObject = pNewXORes->GetDict("XObject");
482     if (!pXObject) {
483       pXObject = new CPDF_Dictionary;
484       pNewXORes->SetAt("XObject", pXObject);
485     }
486
487     CFX_ByteString sFormName;
488     sFormName.Format("F%d", i);
489     FX_DWORD dwObjNum = pDocument->AddIndirectObject(pObj);
490     pXObject->SetAtReference(sFormName, pDocument, dwObjNum);
491
492     CPDF_StreamAcc acc;
493     acc.LoadAllData(pNewXObject);
494
495     const uint8_t* pData = acc.GetData();
496     CFX_ByteString sStream(pData, acc.GetSize());
497     CFX_ByteString sTemp;
498
499     if (matrix.IsIdentity()) {
500       matrix.a = 1.0f;
501       matrix.b = 0.0f;
502       matrix.c = 0.0f;
503       matrix.d = 1.0f;
504       matrix.e = 0.0f;
505       matrix.f = 0.0f;
506     }
507
508     CFX_AffineMatrix m = GetMatrix(rcAnnot, rcStream, matrix);
509     sTemp.Format("q %f 0 0 %f %f %f cm /%s Do Q\n", m.a, m.d, m.e, m.f,
510                  sFormName.c_str());
511     sStream += sTemp;
512
513     pNewXObject->SetData((const uint8_t*)sStream, sStream.GetLength(), FALSE,
514                          FALSE);
515   }
516   pPageDict->RemoveAt("Annots");
517
518   ObjectArray.RemoveAll();
519   RectArray.RemoveAll();
520
521   return FLATTEN_SUCCESS;
522 }