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