From c345065e7aff3368198624f303e711a244e2f7ec Mon Sep 17 00:00:00 2001 From: Lei Zhang Date: Thu, 11 Oct 2018 16:54:42 +0000 Subject: Rename interform files to interactiveform. Just rename the files in this CL. Change-Id: I39f7fefa885977fffab6c909762b05484a1c923d Reviewed-on: https://pdfium-review.googlesource.com/c/43814 Reviewed-by: Tom Sepez Commit-Queue: Lei Zhang --- BUILD.gn | 8 +- core/fpdfdoc/cpdf_annotlist.cpp | 2 +- core/fpdfdoc/cpdf_formcontrol.cpp | 2 +- core/fpdfdoc/cpdf_formfield.cpp | 2 +- core/fpdfdoc/cpdf_interactiveform.cpp | 1066 +++++++++++++++++++++ core/fpdfdoc/cpdf_interactiveform.h | 111 +++ core/fpdfdoc/cpdf_interform.cpp | 1066 --------------------- core/fpdfdoc/cpdf_interform.h | 111 --- core/fpdfdoc/cpvt_fontmap.cpp | 2 +- fpdfsdk/cpdfsdk_actionhandler.cpp | 4 +- fpdfsdk/cpdfsdk_baannothandler.cpp | 2 +- fpdfsdk/cpdfsdk_formfillenvironment.cpp | 2 +- fpdfsdk/cpdfsdk_helpers.cpp | 2 +- fpdfsdk/cpdfsdk_interactiveform.cpp | 672 +++++++++++++ fpdfsdk/cpdfsdk_interactiveform.h | 132 +++ fpdfsdk/cpdfsdk_interform.cpp | 672 ------------- fpdfsdk/cpdfsdk_interform.h | 132 --- fpdfsdk/cpdfsdk_pageview.cpp | 4 +- fpdfsdk/cpdfsdk_widget.cpp | 4 +- fpdfsdk/cpdfsdk_widgethandler.cpp | 4 +- fpdfsdk/cpdfsdk_xfawidgethandler.cpp | 4 +- fpdfsdk/formfiller/cffl_interactiveformfiller.cpp | 2 +- fpdfsdk/fpdf_annot.cpp | 2 +- fpdfsdk/fpdf_ext.cpp | 2 +- fpdfsdk/fpdf_formfill.cpp | 4 +- fpdfsdk/fpdfxfa/cpdfxfa_docenvironment.cpp | 2 +- fpdfsdk/pwl/cpwl_appstream.cpp | 2 +- fxjs/cjs_app.cpp | 2 +- fxjs/cjs_document.cpp | 4 +- fxjs/cjs_field.cpp | 4 +- fxjs/cjs_publicmethods.cpp | 4 +- 31 files changed, 2016 insertions(+), 2016 deletions(-) create mode 100644 core/fpdfdoc/cpdf_interactiveform.cpp create mode 100644 core/fpdfdoc/cpdf_interactiveform.h delete mode 100644 core/fpdfdoc/cpdf_interform.cpp delete mode 100644 core/fpdfdoc/cpdf_interform.h create mode 100644 fpdfsdk/cpdfsdk_interactiveform.cpp create mode 100644 fpdfsdk/cpdfsdk_interactiveform.h delete mode 100644 fpdfsdk/cpdfsdk_interform.cpp delete mode 100644 fpdfsdk/cpdfsdk_interform.h diff --git a/BUILD.gn b/BUILD.gn index 9ba9d891c6..2171d148dc 100644 --- a/BUILD.gn +++ b/BUILD.gn @@ -130,8 +130,8 @@ jumbo_static_library("pdfium") { "fpdfsdk/cpdfsdk_formfillenvironment.h", "fpdfsdk/cpdfsdk_helpers.cpp", "fpdfsdk/cpdfsdk_helpers.h", - "fpdfsdk/cpdfsdk_interform.cpp", - "fpdfsdk/cpdfsdk_interform.h", + "fpdfsdk/cpdfsdk_interactiveform.cpp", + "fpdfsdk/cpdfsdk_interactiveform.h", "fpdfsdk/cpdfsdk_pageview.cpp", "fpdfsdk/cpdfsdk_pageview.h", "fpdfsdk/cpdfsdk_widget.cpp", @@ -349,8 +349,8 @@ jumbo_static_library("fpdfdoc") { "core/fpdfdoc/cpdf_formfield.h", "core/fpdfdoc/cpdf_iconfit.cpp", "core/fpdfdoc/cpdf_iconfit.h", - "core/fpdfdoc/cpdf_interform.cpp", - "core/fpdfdoc/cpdf_interform.h", + "core/fpdfdoc/cpdf_interactiveform.cpp", + "core/fpdfdoc/cpdf_interactiveform.h", "core/fpdfdoc/cpdf_link.cpp", "core/fpdfdoc/cpdf_link.h", "core/fpdfdoc/cpdf_linklist.cpp", diff --git a/core/fpdfdoc/cpdf_annotlist.cpp b/core/fpdfdoc/cpdf_annotlist.cpp index f6959fb78f..19a835297c 100644 --- a/core/fpdfdoc/cpdf_annotlist.cpp +++ b/core/fpdfdoc/cpdf_annotlist.cpp @@ -21,7 +21,7 @@ #include "core/fpdfapi/render/cpdf_renderoptions.h" #include "core/fpdfdoc/cpdf_annot.h" #include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpdf_occontext.h" #include "core/fpdfdoc/cpvt_generateap.h" #include "core/fxge/cfx_renderdevice.h" diff --git a/core/fpdfdoc/cpdf_formcontrol.cpp b/core/fpdfdoc/cpdf_formcontrol.cpp index 7b95c09464..6ce14ed7ab 100644 --- a/core/fpdfdoc/cpdf_formcontrol.cpp +++ b/core/fpdfdoc/cpdf_formcontrol.cpp @@ -14,7 +14,7 @@ #include "core/fpdfapi/parser/cpdf_name.h" #include "core/fpdfapi/parser/cpdf_stream.h" #include "core/fpdfapi/parser/fpdf_parser_decode.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" namespace { diff --git a/core/fpdfdoc/cpdf_formfield.cpp b/core/fpdfdoc/cpdf_formfield.cpp index fb70daffd8..4b1b9b401c 100644 --- a/core/fpdfdoc/cpdf_formfield.cpp +++ b/core/fpdfdoc/cpdf_formfield.cpp @@ -21,7 +21,7 @@ #include "core/fpdfapi/parser/fpdf_parser_decode.h" #include "core/fpdfdoc/cpdf_defaultappearance.h" #include "core/fpdfdoc/cpdf_formcontrol.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpvt_generateap.h" #include "third_party/base/ptr_util.h" #include "third_party/base/stl_util.h" diff --git a/core/fpdfdoc/cpdf_interactiveform.cpp b/core/fpdfdoc/cpdf_interactiveform.cpp new file mode 100644 index 0000000000..e05979d341 --- /dev/null +++ b/core/fpdfdoc/cpdf_interactiveform.cpp @@ -0,0 +1,1066 @@ +// Copyright 2016 PDFium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com + +#include "core/fpdfdoc/cpdf_interactiveform.h" + +#include +#include + +#include "constants/stream_dict_common.h" +#include "core/fpdfapi/font/cpdf_font.h" +#include "core/fpdfapi/font/cpdf_fontencoding.h" +#include "core/fpdfapi/page/cpdf_page.h" +#include "core/fpdfapi/parser/cfdf_document.h" +#include "core/fpdfapi/parser/cpdf_array.h" +#include "core/fpdfapi/parser/cpdf_dictionary.h" +#include "core/fpdfapi/parser/cpdf_document.h" +#include "core/fpdfapi/parser/cpdf_name.h" +#include "core/fpdfapi/parser/cpdf_reference.h" +#include "core/fpdfapi/parser/cpdf_string.h" +#include "core/fpdfapi/parser/fpdf_parser_utility.h" +#include "core/fpdfdoc/cpdf_filespec.h" +#include "core/fpdfdoc/cpdf_formcontrol.h" +#include "core/fxcrt/fx_codepage.h" +#include "core/fxge/cfx_substfont.h" +#include "core/fxge/fx_font.h" +#include "third_party/base/ptr_util.h" +#include "third_party/base/stl_util.h" + +namespace { + +const int nMaxRecursion = 32; + +ByteString GenerateNewFontResourceName(const CPDF_Dictionary* pResDict, + const ByteString& csPrefix) { + static const char kDummyFontName[] = "ZiTi"; + ByteString csStr = csPrefix; + if (csStr.IsEmpty()) + csStr = kDummyFontName; + + const size_t szCount = csStr.GetLength(); + size_t m = 0; + ByteString csTmp; + while (m < strlen(kDummyFontName) && m < szCount) + csTmp += csStr[m++]; + while (m < strlen(kDummyFontName)) { + csTmp += '0' + m % 10; + m++; + } + + const CPDF_Dictionary* pDict = pResDict->GetDictFor("Font"); + ASSERT(pDict); + + int num = 0; + ByteString bsNum; + while (true) { + ByteString csKey = csTmp + bsNum; + if (!pDict->KeyExist(csKey)) + return csKey; + if (m < szCount) + csTmp += csStr[m++]; + else + bsNum = ByteString::Format("%d", num++); + + m++; + } + return csTmp; +} + +void AddFont(CPDF_Dictionary*& pFormDict, + CPDF_Document* pDocument, + const CPDF_Font* pFont, + ByteString* csNameTag); + +void InitDict(CPDF_Dictionary*& pFormDict, CPDF_Document* pDocument) { + if (!pDocument) + return; + + if (!pFormDict) { + pFormDict = pDocument->NewIndirect(); + pDocument->GetRoot()->SetFor("AcroForm", + pFormDict->MakeReference(pDocument)); + } + + ByteString csDA; + if (!pFormDict->KeyExist("DR")) { + ByteString csBaseName; + uint8_t charSet = CPDF_InterForm::GetNativeCharSet(); + CPDF_Font* pFont = CPDF_InterForm::AddStandardFont( + pDocument, CFX_Font::kDefaultAnsiFontName); + if (pFont) + AddFont(pFormDict, pDocument, pFont, &csBaseName); + + if (charSet != FX_CHARSET_ANSI) { + ByteString csFontName = CPDF_InterForm::GetNativeFont(charSet, nullptr); + if (!pFont || csFontName != CFX_Font::kDefaultAnsiFontName) { + pFont = CPDF_InterForm::AddNativeFont(pDocument); + if (pFont) { + csBaseName.clear(); + AddFont(pFormDict, pDocument, pFont, &csBaseName); + } + } + } + if (pFont) + csDA = "/" + PDF_NameEncode(csBaseName) + " 0 Tf"; + } + if (!csDA.IsEmpty()) + csDA += " "; + + csDA += "0 g"; + if (!pFormDict->KeyExist("DA")) + pFormDict->SetNewFor("DA", csDA, false); +} + +CPDF_Font* GetFont(CPDF_Dictionary* pFormDict, + CPDF_Document* pDocument, + const ByteString& csNameTag) { + ByteString csAlias = PDF_NameDecode(csNameTag.AsStringView()); + if (!pFormDict || csAlias.IsEmpty()) + return nullptr; + + CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); + if (!pDR) + return nullptr; + + CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); + if (!pFonts) + return nullptr; + + CPDF_Dictionary* pElement = pFonts->GetDictFor(csAlias); + if (!pElement) + return nullptr; + + if (pElement->GetStringFor("Type") == "Font") + return pDocument->LoadFont(pElement); + return nullptr; +} + +CPDF_Font* GetNativeFont(CPDF_Dictionary* pFormDict, + CPDF_Document* pDocument, + uint8_t charSet, + ByteString* csNameTag) { + if (!pFormDict) + return nullptr; + + CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); + if (!pDR) + return nullptr; + + CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); + if (!pFonts) + return nullptr; + + for (const auto& it : *pFonts) { + const ByteString& csKey = it.first; + if (!it.second) + continue; + + CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); + if (!pElement) + continue; + if (pElement->GetStringFor("Type") != "Font") + continue; + CPDF_Font* pFind = pDocument->LoadFont(pElement); + if (!pFind) + continue; + + CFX_SubstFont* pSubst = pFind->GetSubstFont(); + if (!pSubst) + continue; + + if (pSubst->m_Charset == static_cast(charSet)) { + *csNameTag = csKey; + return pFind; + } + } + return nullptr; +} + +bool FindFont(CPDF_Dictionary* pFormDict, + const CPDF_Font* pFont, + ByteString* csNameTag) { + if (!pFormDict || !pFont) + return false; + + CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); + if (!pDR) + return false; + + CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); + if (!pFonts) + return false; + + for (const auto& it : *pFonts) { + const ByteString& csKey = it.first; + if (!it.second) + continue; + CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); + if (!pElement) + continue; + if (pElement->GetStringFor("Type") != "Font") + continue; + if (pFont->GetFontDict() == pElement) { + *csNameTag = csKey; + return true; + } + } + return false; +} + +bool FindFont(CPDF_Dictionary* pFormDict, + CPDF_Document* pDocument, + ByteString csFontName, + CPDF_Font*& pFont, + ByteString* csNameTag) { + if (!pFormDict) + return false; + + CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); + if (!pDR) + return false; + + CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); + if (!pFonts) + return false; + + if (csFontName.GetLength() > 0) + csFontName.Remove(' '); + + for (const auto& it : *pFonts) { + const ByteString& csKey = it.first; + if (!it.second) + continue; + + CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); + if (!pElement) + continue; + if (pElement->GetStringFor("Type") != "Font") + continue; + pFont = pDocument->LoadFont(pElement); + if (!pFont) + continue; + + ByteString csBaseFont = pFont->GetBaseFont(); + csBaseFont.Remove(' '); + if (csBaseFont == csFontName) { + *csNameTag = csKey; + return true; + } + } + return false; +} + +void AddFont(CPDF_Dictionary*& pFormDict, + CPDF_Document* pDocument, + const CPDF_Font* pFont, + ByteString* csNameTag) { + if (!pFont) + return; + if (!pFormDict) + InitDict(pFormDict, pDocument); + + ByteString csTag; + if (FindFont(pFormDict, pFont, &csTag)) { + *csNameTag = std::move(csTag); + return; + } + if (!pFormDict) + InitDict(pFormDict, pDocument); + + CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); + if (!pDR) + pDR = pFormDict->SetNewFor("DR"); + + CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); + if (!pFonts) + pFonts = pDR->SetNewFor("Font"); + + if (csNameTag->IsEmpty()) + *csNameTag = pFont->GetBaseFont(); + + csNameTag->Remove(' '); + *csNameTag = GenerateNewFontResourceName(pDR, *csNameTag); + pFonts->SetFor(*csNameTag, pFont->GetFontDict()->MakeReference(pDocument)); +} + +CPDF_Font* AddNativeFont(CPDF_Dictionary*& pFormDict, + CPDF_Document* pDocument, + uint8_t charSet, + ByteString* csNameTag) { + if (!pFormDict) + InitDict(pFormDict, pDocument); + + ByteString csTemp; + CPDF_Font* pFont = GetNativeFont(pFormDict, pDocument, charSet, &csTemp); + if (pFont) { + *csNameTag = std::move(csTemp); + return pFont; + } + ByteString csFontName = CPDF_InterForm::GetNativeFont(charSet, nullptr); + if (!csFontName.IsEmpty() && + FindFont(pFormDict, pDocument, csFontName, pFont, csNameTag)) { + return pFont; + } + pFont = CPDF_InterForm::AddNativeFont(charSet, pDocument); + if (pFont) + AddFont(pFormDict, pDocument, pFont, csNameTag); + + return pFont; +} + +class CFieldNameExtractor { + public: + explicit CFieldNameExtractor(const WideString& full_name) + : m_FullName(full_name) { + m_pCur = m_FullName.c_str(); + m_pEnd = m_pCur + m_FullName.GetLength(); + } + + void GetNext(const wchar_t*& pSubName, size_t& size) { + pSubName = m_pCur; + while (m_pCur < m_pEnd && m_pCur[0] != L'.') + m_pCur++; + + size = static_cast(m_pCur - pSubName); + if (m_pCur < m_pEnd && m_pCur[0] == L'.') + m_pCur++; + } + + protected: + WideString m_FullName; + const wchar_t* m_pCur; + const wchar_t* m_pEnd; +}; + +#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ +struct PDF_FONTDATA { + bool bFind; + LOGFONTA lf; +}; + +static int CALLBACK EnumFontFamExProc(ENUMLOGFONTEXA* lpelfe, + NEWTEXTMETRICEX* lpntme, + DWORD FontType, + LPARAM lParam) { + if (FontType != 0x004 || strchr(lpelfe->elfLogFont.lfFaceName, '@')) + return 1; + + PDF_FONTDATA* pData = (PDF_FONTDATA*)lParam; + memcpy(&pData->lf, &lpelfe->elfLogFont, sizeof(LOGFONTA)); + pData->bFind = true; + return 0; +} + +bool RetrieveSpecificFont(LOGFONTA& lf) { + PDF_FONTDATA fd; + memset(&fd, 0, sizeof(PDF_FONTDATA)); + HDC hDC = ::GetDC(nullptr); + EnumFontFamiliesExA(hDC, &lf, (FONTENUMPROCA)EnumFontFamExProc, (LPARAM)&fd, + 0); + ::ReleaseDC(nullptr, hDC); + if (fd.bFind) + memcpy(&lf, &fd.lf, sizeof(LOGFONTA)); + + return fd.bFind; +} + +bool RetrieveSpecificFont(uint8_t charSet, + uint8_t pitchAndFamily, + LPCSTR pcsFontName, + LOGFONTA& lf) { + memset(&lf, 0, sizeof(LOGFONTA)); + lf.lfCharSet = charSet; + lf.lfPitchAndFamily = pitchAndFamily; + if (pcsFontName) { + // TODO(dsinclair): Should this be strncpy? + // NOLINTNEXTLINE(runtime/printf) + strcpy(lf.lfFaceName, pcsFontName); + } + return RetrieveSpecificFont(lf); +} +#endif // _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ + +} // namespace + +class CFieldTree { + public: + class Node { + public: + Node() : m_pField(nullptr), m_level(0) {} + Node(const WideString& short_name, int level) + : m_ShortName(short_name), m_level(level) {} + ~Node() {} + + void AddChildNode(std::unique_ptr pNode) { + m_Children.push_back(std::move(pNode)); + } + + size_t GetChildrenCount() const { return m_Children.size(); } + + Node* GetChildAt(size_t i) { return m_Children[i].get(); } + const Node* GetChildAt(size_t i) const { return m_Children[i].get(); } + + CPDF_FormField* GetFieldAtIndex(size_t index) { + size_t nFieldsToGo = index; + return GetFieldInternal(&nFieldsToGo); + } + + size_t CountFields() const { return CountFieldsInternal(); } + + void SetField(std::unique_ptr pField) { + m_pField = std::move(pField); + } + + CPDF_FormField* GetField() const { return m_pField.get(); } + WideString GetShortName() const { return m_ShortName; } + int GetLevel() const { return m_level; } + + private: + CPDF_FormField* GetFieldInternal(size_t* pFieldsToGo) { + if (m_pField) { + if (*pFieldsToGo == 0) + return m_pField.get(); + + --*pFieldsToGo; + } + for (size_t i = 0; i < GetChildrenCount(); ++i) { + CPDF_FormField* pField = GetChildAt(i)->GetFieldInternal(pFieldsToGo); + if (pField) + return pField; + } + return nullptr; + } + + size_t CountFieldsInternal() const { + size_t count = 0; + if (m_pField) + ++count; + + for (size_t i = 0; i < GetChildrenCount(); ++i) + count += GetChildAt(i)->CountFieldsInternal(); + return count; + } + + std::vector> m_Children; + WideString m_ShortName; + std::unique_ptr m_pField; + const int m_level; + }; + + CFieldTree(); + ~CFieldTree(); + + bool SetField(const WideString& full_name, + std::unique_ptr pField); + CPDF_FormField* GetField(const WideString& full_name); + + Node* FindNode(const WideString& full_name); + Node* AddChild(Node* pParent, const WideString& short_name); + + Node* Lookup(Node* pParent, const WideString& short_name); + + Node m_Root; +}; + +CFieldTree::CFieldTree() {} + +CFieldTree::~CFieldTree() {} + +CFieldTree::Node* CFieldTree::AddChild(Node* pParent, + const WideString& short_name) { + if (!pParent) + return nullptr; + + int level = pParent->GetLevel() + 1; + if (level > nMaxRecursion) + return nullptr; + + auto pNew = pdfium::MakeUnique(short_name, pParent->GetLevel() + 1); + Node* pChild = pNew.get(); + pParent->AddChildNode(std::move(pNew)); + return pChild; +} + +CFieldTree::Node* CFieldTree::Lookup(Node* pParent, + const WideString& short_name) { + if (!pParent) + return nullptr; + + for (size_t i = 0; i < pParent->GetChildrenCount(); ++i) { + Node* pNode = pParent->GetChildAt(i); + if (pNode->GetShortName() == short_name) + return pNode; + } + return nullptr; +} + +bool CFieldTree::SetField(const WideString& full_name, + std::unique_ptr pField) { + if (full_name.IsEmpty()) + return false; + + CFieldNameExtractor name_extractor(full_name); + const wchar_t* pName; + size_t nLength; + name_extractor.GetNext(pName, nLength); + Node* pNode = &m_Root; + Node* pLast = nullptr; + while (nLength > 0) { + pLast = pNode; + WideString name = WideString(pName, nLength); + pNode = Lookup(pLast, name); + if (!pNode) + pNode = AddChild(pLast, name); + if (!pNode) + return false; + + name_extractor.GetNext(pName, nLength); + } + if (pNode == &m_Root) + return false; + + pNode->SetField(std::move(pField)); + return true; +} + +CPDF_FormField* CFieldTree::GetField(const WideString& full_name) { + if (full_name.IsEmpty()) + return nullptr; + + CFieldNameExtractor name_extractor(full_name); + const wchar_t* pName; + size_t nLength; + name_extractor.GetNext(pName, nLength); + Node* pNode = &m_Root; + Node* pLast = nullptr; + while (nLength > 0 && pNode) { + pLast = pNode; + WideString name = WideString(pName, nLength); + pNode = Lookup(pLast, name); + name_extractor.GetNext(pName, nLength); + } + return pNode ? pNode->GetField() : nullptr; +} + +CFieldTree::Node* CFieldTree::FindNode(const WideString& full_name) { + if (full_name.IsEmpty()) + return nullptr; + + CFieldNameExtractor name_extractor(full_name); + const wchar_t* pName; + size_t nLength; + name_extractor.GetNext(pName, nLength); + Node* pNode = &m_Root; + Node* pLast = nullptr; + while (nLength > 0 && pNode) { + pLast = pNode; + WideString name = WideString(pName, nLength); + pNode = Lookup(pLast, name); + name_extractor.GetNext(pName, nLength); + } + return pNode; +} + +CPDF_Font* AddNativeInterFormFont(CPDF_Dictionary*& pFormDict, + CPDF_Document* pDocument, + ByteString* csNameTag) { + uint8_t charSet = CPDF_InterForm::GetNativeCharSet(); + return AddNativeFont(pFormDict, pDocument, charSet, csNameTag); +} + +// static +uint8_t CPDF_InterForm::GetNativeCharSet() { + return FX_GetCharsetFromCodePage(FXSYS_GetACP()); +} + +CPDF_InterForm::CPDF_InterForm(CPDF_Document* pDocument) + : m_pDocument(pDocument), m_pFieldTree(pdfium::MakeUnique()) { + CPDF_Dictionary* pRoot = m_pDocument->GetRoot(); + if (!pRoot) + return; + + m_pFormDict = pRoot->GetDictFor("AcroForm"); + if (!m_pFormDict) + return; + + CPDF_Array* pFields = m_pFormDict->GetArrayFor("Fields"); + if (!pFields) + return; + + for (size_t i = 0; i < pFields->GetCount(); ++i) + LoadField(pFields->GetDictAt(i), 0); +} + +CPDF_InterForm::~CPDF_InterForm() {} + +bool CPDF_InterForm::s_bUpdateAP = true; + +bool CPDF_InterForm::IsUpdateAPEnabled() { + return s_bUpdateAP; +} + +void CPDF_InterForm::SetUpdateAP(bool bUpdateAP) { + s_bUpdateAP = bUpdateAP; +} + +CPDF_Font* CPDF_InterForm::AddStandardFont(CPDF_Document* pDocument, + ByteString csFontName) { + if (!pDocument || csFontName.IsEmpty()) + return nullptr; + + if (csFontName == "ZapfDingbats") + return pDocument->AddStandardFont(csFontName.c_str(), nullptr); + + CPDF_FontEncoding encoding(PDFFONT_ENCODING_WINANSI); + return pDocument->AddStandardFont(csFontName.c_str(), &encoding); +} + +ByteString CPDF_InterForm::GetNativeFont(uint8_t charSet, void* pLogFont) { + ByteString csFontName; +#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ + LOGFONTA lf = {}; + if (charSet == FX_CHARSET_ANSI) { + csFontName = CFX_Font::kDefaultAnsiFontName; + return csFontName; + } + bool bRet = false; + const ByteString default_font_name = + CFX_Font::GetDefaultFontNameByCharset(charSet); + if (!default_font_name.IsEmpty()) { + bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, + default_font_name.c_str(), lf); + } + if (!bRet) { + bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, + CFX_Font::kUniversalDefaultFontName, lf); + } + if (!bRet) { + bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, + "Microsoft Sans Serif", lf); + } + if (!bRet) { + bRet = + RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, nullptr, lf); + } + if (bRet) { + if (pLogFont) + memcpy(pLogFont, &lf, sizeof(LOGFONTA)); + + csFontName = lf.lfFaceName; + return csFontName; + } +#endif + return csFontName; +} + +CPDF_Font* CPDF_InterForm::AddNativeFont(uint8_t charSet, + CPDF_Document* pDocument) { + if (!pDocument) + return nullptr; + +#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ + LOGFONTA lf; + ByteString csFontName = GetNativeFont(charSet, &lf); + if (!csFontName.IsEmpty()) { + if (csFontName == CFX_Font::kDefaultAnsiFontName) + return AddStandardFont(pDocument, csFontName); + return pDocument->AddWindowsFont(&lf); + } +#endif + return nullptr; +} + +CPDF_Font* CPDF_InterForm::AddNativeFont(CPDF_Document* pDocument) { + return pDocument ? AddNativeFont(GetNativeCharSet(), pDocument) : nullptr; +} + +size_t CPDF_InterForm::CountFields(const WideString& csFieldName) const { + if (csFieldName.IsEmpty()) + return m_pFieldTree->m_Root.CountFields(); + + CFieldTree::Node* pNode = m_pFieldTree->FindNode(csFieldName); + return pNode ? pNode->CountFields() : 0; +} + +CPDF_FormField* CPDF_InterForm::GetField(uint32_t index, + const WideString& csFieldName) const { + if (csFieldName.IsEmpty()) + return m_pFieldTree->m_Root.GetFieldAtIndex(index); + + CFieldTree::Node* pNode = m_pFieldTree->FindNode(csFieldName); + return pNode ? pNode->GetFieldAtIndex(index) : nullptr; +} + +CPDF_FormField* CPDF_InterForm::GetFieldByDict( + CPDF_Dictionary* pFieldDict) const { + if (!pFieldDict) + return nullptr; + + WideString csWName = FPDF_GetFullName(pFieldDict); + return m_pFieldTree->GetField(csWName); +} + +CPDF_FormControl* CPDF_InterForm::GetControlAtPoint(CPDF_Page* pPage, + const CFX_PointF& point, + + int* z_order) const { + CPDF_Array* pAnnotList = pPage->GetDict()->GetArrayFor("Annots"); + if (!pAnnotList) + return nullptr; + + for (size_t i = pAnnotList->GetCount(); i > 0; --i) { + size_t annot_index = i - 1; + CPDF_Dictionary* pAnnot = pAnnotList->GetDictAt(annot_index); + if (!pAnnot) + continue; + + const auto it = m_ControlMap.find(pAnnot); + if (it == m_ControlMap.end()) + continue; + + CPDF_FormControl* pControl = it->second.get(); + if (!pControl->GetRect().Contains(point)) + continue; + + if (z_order) + *z_order = static_cast(annot_index); + return pControl; + } + return nullptr; +} + +CPDF_FormControl* CPDF_InterForm::GetControlByDict( + const CPDF_Dictionary* pWidgetDict) const { + const auto it = m_ControlMap.find(pWidgetDict); + return it != m_ControlMap.end() ? it->second.get() : nullptr; +} + +bool CPDF_InterForm::NeedConstructAP() const { + return m_pFormDict && m_pFormDict->GetBooleanFor("NeedAppearances", false); +} + +int CPDF_InterForm::CountFieldsInCalculationOrder() { + if (!m_pFormDict) + return 0; + + CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); + return pArray ? pArray->GetCount() : 0; +} + +CPDF_FormField* CPDF_InterForm::GetFieldInCalculationOrder(int index) { + if (!m_pFormDict || index < 0) + return nullptr; + + CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); + if (!pArray) + return nullptr; + + CPDF_Dictionary* pElement = ToDictionary(pArray->GetDirectObjectAt(index)); + return pElement ? GetFieldByDict(pElement) : nullptr; +} + +int CPDF_InterForm::FindFieldInCalculationOrder(const CPDF_FormField* pField) { + if (!m_pFormDict || !pField) + return -1; + + CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); + if (!pArray) + return -1; + + for (size_t i = 0; i < pArray->GetCount(); i++) { + CPDF_Object* pElement = pArray->GetDirectObjectAt(i); + if (pElement == pField->GetDict()) + return i; + } + return -1; +} + +CPDF_Font* CPDF_InterForm::GetFormFont(ByteString csNameTag) const { + return GetFont(m_pFormDict.Get(), m_pDocument.Get(), csNameTag); +} + +CPDF_DefaultAppearance CPDF_InterForm::GetDefaultAppearance() const { + if (!m_pFormDict) + return CPDF_DefaultAppearance(); + return CPDF_DefaultAppearance(m_pFormDict->GetStringFor("DA")); +} + +int CPDF_InterForm::GetFormAlignment() const { + return m_pFormDict ? m_pFormDict->GetIntegerFor("Q", 0) : 0; +} + +void CPDF_InterForm::ResetForm(const std::vector& fields, + bool bIncludeOrExclude, + NotificationOption notify) { + size_t nCount = m_pFieldTree->m_Root.CountFields(); + for (size_t i = 0; i < nCount; ++i) { + CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); + if (!pField) + continue; + + if (bIncludeOrExclude == pdfium::ContainsValue(fields, pField)) + pField->ResetField(notify); + } + if (notify == NotificationOption::kNotify && m_pFormNotify) + m_pFormNotify->AfterFormReset(this); +} + +void CPDF_InterForm::ResetForm(NotificationOption notify) { + size_t nCount = m_pFieldTree->m_Root.CountFields(); + for (size_t i = 0; i < nCount; ++i) { + CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); + if (!pField) + continue; + + pField->ResetField(notify); + } + if (notify == NotificationOption::kNotify && m_pFormNotify) + m_pFormNotify->AfterFormReset(this); +} + +void CPDF_InterForm::LoadField(CPDF_Dictionary* pFieldDict, int nLevel) { + if (nLevel > nMaxRecursion) + return; + if (!pFieldDict) + return; + + uint32_t dwParentObjNum = pFieldDict->GetObjNum(); + CPDF_Array* pKids = pFieldDict->GetArrayFor("Kids"); + if (!pKids) { + AddTerminalField(pFieldDict); + return; + } + + CPDF_Dictionary* pFirstKid = pKids->GetDictAt(0); + if (!pFirstKid) + return; + + if (pFirstKid->KeyExist("T") || pFirstKid->KeyExist("Kids")) { + for (size_t i = 0; i < pKids->GetCount(); i++) { + CPDF_Dictionary* pChildDict = pKids->GetDictAt(i); + if (pChildDict) { + if (pChildDict->GetObjNum() != dwParentObjNum) + LoadField(pChildDict, nLevel + 1); + } + } + } else { + AddTerminalField(pFieldDict); + } +} + +bool CPDF_InterForm::HasXFAForm() const { + return m_pFormDict && m_pFormDict->GetArrayFor("XFA"); +} + +void CPDF_InterForm::FixPageFields(CPDF_Page* pPage) { + CPDF_Dictionary* pPageDict = pPage->GetDict(); + if (!pPageDict) + return; + + CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots"); + if (!pAnnots) + return; + + for (size_t i = 0; i < pAnnots->GetCount(); i++) { + CPDF_Dictionary* pAnnot = pAnnots->GetDictAt(i); + if (pAnnot && pAnnot->GetStringFor("Subtype") == "Widget") + LoadField(pAnnot, 0); + } +} + +void CPDF_InterForm::AddTerminalField(CPDF_Dictionary* pFieldDict) { + if (!pFieldDict->KeyExist("FT")) { + // Key "FT" is required for terminal fields, it is also inheritable. + CPDF_Dictionary* pParentDict = pFieldDict->GetDictFor("Parent"); + if (!pParentDict || !pParentDict->KeyExist("FT")) + return; + } + + CPDF_Dictionary* pDict = pFieldDict; + WideString csWName = FPDF_GetFullName(pFieldDict); + if (csWName.IsEmpty()) + return; + + CPDF_FormField* pField = nullptr; + pField = m_pFieldTree->GetField(csWName); + if (!pField) { + CPDF_Dictionary* pParent = pFieldDict; + if (!pFieldDict->KeyExist("T") && + pFieldDict->GetStringFor("Subtype") == "Widget") { + pParent = pFieldDict->GetDictFor("Parent"); + if (!pParent) + pParent = pFieldDict; + } + + if (pParent && pParent != pFieldDict && !pParent->KeyExist("FT")) { + if (pFieldDict->KeyExist("FT")) { + CPDF_Object* pFTValue = pFieldDict->GetDirectObjectFor("FT"); + if (pFTValue) + pParent->SetFor("FT", pFTValue->Clone()); + } + + if (pFieldDict->KeyExist("Ff")) { + CPDF_Object* pFfValue = pFieldDict->GetDirectObjectFor("Ff"); + if (pFfValue) + pParent->SetFor("Ff", pFfValue->Clone()); + } + } + + auto newField = pdfium::MakeUnique(this, pParent); + pField = newField.get(); + CPDF_Object* pTObj = pDict->GetObjectFor("T"); + if (ToReference(pTObj)) { + std::unique_ptr pClone = pTObj->CloneDirectObject(); + if (pClone) + pDict->SetFor("T", std::move(pClone)); + else + pDict->SetNewFor("T", ""); + } + if (!m_pFieldTree->SetField(csWName, std::move(newField))) + return; + } + + CPDF_Array* pKids = pFieldDict->GetArrayFor("Kids"); + if (pKids) { + for (size_t i = 0; i < pKids->GetCount(); i++) { + CPDF_Dictionary* pKid = pKids->GetDictAt(i); + if (!pKid) + continue; + if (pKid->GetStringFor("Subtype") != "Widget") + continue; + + AddControl(pField, pKid); + } + } else { + if (pFieldDict->GetStringFor("Subtype") == "Widget") + AddControl(pField, pFieldDict); + } +} + +CPDF_FormControl* CPDF_InterForm::AddControl(CPDF_FormField* pField, + CPDF_Dictionary* pWidgetDict) { + const auto it = m_ControlMap.find(pWidgetDict); + if (it != m_ControlMap.end()) + return it->second.get(); + + auto pNew = pdfium::MakeUnique(pField, pWidgetDict); + CPDF_FormControl* pControl = pNew.get(); + m_ControlMap[pWidgetDict] = std::move(pNew); + pField->AddFormControl(pControl); + return pControl; +} + +bool CPDF_InterForm::CheckRequiredFields( + const std::vector* fields, + bool bIncludeOrExclude) const { + size_t nCount = m_pFieldTree->m_Root.CountFields(); + for (size_t i = 0; i < nCount; ++i) { + CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); + if (!pField) + continue; + + int32_t iType = pField->GetType(); + if (iType == CPDF_FormField::PushButton || + iType == CPDF_FormField::CheckBox || iType == CPDF_FormField::ListBox) { + continue; + } + if (pField->IsNoExport()) + continue; + + bool bFind = true; + if (fields) + bFind = pdfium::ContainsValue(*fields, pField); + if (bIncludeOrExclude == bFind) { + const CPDF_Dictionary* pFieldDict = pField->GetDict(); + if (pField->IsRequired() && pFieldDict->GetStringFor("V").IsEmpty()) + return false; + } + } + return true; +} + +std::unique_ptr CPDF_InterForm::ExportToFDF( + const WideString& pdf_path, + bool bSimpleFileSpec) const { + std::vector fields; + size_t nCount = m_pFieldTree->m_Root.CountFields(); + for (size_t i = 0; i < nCount; ++i) + fields.push_back(m_pFieldTree->m_Root.GetFieldAtIndex(i)); + return ExportToFDF(pdf_path, fields, true, bSimpleFileSpec); +} + +std::unique_ptr CPDF_InterForm::ExportToFDF( + const WideString& pdf_path, + const std::vector& fields, + bool bIncludeOrExclude, + bool bSimpleFileSpec) const { + std::unique_ptr pDoc = CFDF_Document::CreateNewDoc(); + if (!pDoc) + return nullptr; + + CPDF_Dictionary* pMainDict = pDoc->GetRoot()->GetDictFor("FDF"); + if (!pdf_path.IsEmpty()) { + if (bSimpleFileSpec) { + WideString wsFilePath = CPDF_FileSpec::EncodeFileName(pdf_path); + pMainDict->SetNewFor(pdfium::stream::kF, + wsFilePath.ToDefANSI(), false); + pMainDict->SetNewFor("UF", PDF_EncodeText(wsFilePath), + false); + } else { + auto pNewDict = + pdfium::MakeUnique(pDoc->GetByteStringPool()); + pNewDict->SetNewFor("Type", "Filespec"); + CPDF_FileSpec filespec(pNewDict.get()); + filespec.SetFileName(pdf_path); + pMainDict->SetFor("F", std::move(pNewDict)); + } + } + + CPDF_Array* pFields = pMainDict->SetNewFor("Fields"); + size_t nCount = m_pFieldTree->m_Root.CountFields(); + for (size_t i = 0; i < nCount; ++i) { + CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); + if (!pField || pField->GetType() == CPDF_FormField::PushButton) + continue; + + uint32_t dwFlags = pField->GetFieldFlags(); + if (dwFlags & 0x04) + continue; + + if (bIncludeOrExclude != pdfium::ContainsValue(fields, pField)) + continue; + + if ((dwFlags & 0x02) != 0 && + pField->GetDict()->GetStringFor("V").IsEmpty()) { + continue; + } + + WideString fullname = FPDF_GetFullName(pField->GetFieldDict()); + auto pFieldDict = + pdfium::MakeUnique(pDoc->GetByteStringPool()); + pFieldDict->SetNewFor("T", fullname); + if (pField->GetType() == CPDF_FormField::CheckBox || + pField->GetType() == CPDF_FormField::RadioButton) { + WideString csExport = pField->GetCheckValue(false); + ByteString csBExport = PDF_EncodeText(csExport); + CPDF_Object* pOpt = FPDF_GetFieldAttr(pField->GetDict(), "Opt"); + if (pOpt) + pFieldDict->SetNewFor("V", csBExport, false); + else + pFieldDict->SetNewFor("V", csBExport); + } else { + CPDF_Object* pV = FPDF_GetFieldAttr(pField->GetDict(), "V"); + if (pV) + pFieldDict->SetFor("V", pV->CloneDirectObject()); + } + pFields->Add(std::move(pFieldDict)); + } + return pDoc; +} + +void CPDF_InterForm::SetFormNotify(IPDF_FormNotify* pNotify) { + m_pFormNotify = pNotify; +} diff --git a/core/fpdfdoc/cpdf_interactiveform.h b/core/fpdfdoc/cpdf_interactiveform.h new file mode 100644 index 0000000000..ebbbe2778c --- /dev/null +++ b/core/fpdfdoc/cpdf_interactiveform.h @@ -0,0 +1,111 @@ +// Copyright 2016 PDFium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com + +#ifndef CORE_FPDFDOC_CPDF_INTERACTIVEFORM_H_ +#define CORE_FPDFDOC_CPDF_INTERACTIVEFORM_H_ + +#include +#include +#include + +#include "core/fpdfapi/parser/fpdf_parser_decode.h" +#include "core/fpdfdoc/cpdf_defaultappearance.h" +#include "core/fpdfdoc/cpdf_formfield.h" +#include "core/fxcrt/fx_string.h" +#include "core/fxcrt/fx_system.h" +#include "core/fxcrt/unowned_ptr.h" + +class CFieldTree; +class CFDF_Document; +class CPDF_Document; +class CPDF_Dictionary; +class CPDF_Font; +class CPDF_FormControl; +class CPDF_Object; +class CPDF_Page; +class IPDF_FormNotify; + +CPDF_Font* AddNativeInterFormFont(CPDF_Dictionary*& pFormDict, + CPDF_Document* pDocument, + ByteString* csNameTag); + +class CPDF_InterForm { + public: + explicit CPDF_InterForm(CPDF_Document* pDocument); + ~CPDF_InterForm(); + + static void SetUpdateAP(bool bUpdateAP); + static bool IsUpdateAPEnabled(); + static CPDF_Font* AddStandardFont(CPDF_Document* pDocument, + ByteString csFontName); + static ByteString GetNativeFont(uint8_t iCharSet, void* pLogFont); + static uint8_t GetNativeCharSet(); + static CPDF_Font* AddNativeFont(uint8_t iCharSet, CPDF_Document* pDocument); + static CPDF_Font* AddNativeFont(CPDF_Document* pDocument); + + size_t CountFields(const WideString& csFieldName) const; + CPDF_FormField* GetField(uint32_t index, const WideString& csFieldName) const; + CPDF_FormField* GetFieldByDict(CPDF_Dictionary* pFieldDict) const; + + CPDF_FormControl* GetControlAtPoint(CPDF_Page* pPage, + const CFX_PointF& point, + int* z_order) const; + CPDF_FormControl* GetControlByDict(const CPDF_Dictionary* pWidgetDict) const; + + bool NeedConstructAP() const; + int CountFieldsInCalculationOrder(); + CPDF_FormField* GetFieldInCalculationOrder(int index); + int FindFieldInCalculationOrder(const CPDF_FormField* pField); + + CPDF_Font* GetFormFont(ByteString csNameTag) const; + CPDF_DefaultAppearance GetDefaultAppearance() const; + int GetFormAlignment() const; + + bool CheckRequiredFields(const std::vector* fields, + bool bIncludeOrExclude) const; + + std::unique_ptr ExportToFDF(const WideString& pdf_path, + bool bSimpleFileSpec) const; + + std::unique_ptr ExportToFDF( + const WideString& pdf_path, + const std::vector& fields, + bool bIncludeOrExclude, + bool bSimpleFileSpec) const; + + void ResetForm(NotificationOption notify); + + // TODO(tsepez): Use a span. + void ResetForm(const std::vector& fields, + bool bIncludeOrExclude, + NotificationOption notify); + + void SetFormNotify(IPDF_FormNotify* pNotify); + bool HasXFAForm() const; + void FixPageFields(CPDF_Page* pPage); + + IPDF_FormNotify* GetFormNotify() const { return m_pFormNotify.Get(); } + CPDF_Document* GetDocument() const { return m_pDocument.Get(); } + CPDF_Dictionary* GetFormDict() const { return m_pFormDict.Get(); } + + private: + void LoadField(CPDF_Dictionary* pFieldDict, int nLevel); + void AddTerminalField(CPDF_Dictionary* pFieldDict); + CPDF_FormControl* AddControl(CPDF_FormField* pField, + CPDF_Dictionary* pWidgetDict); + + static bool s_bUpdateAP; + + UnownedPtr const m_pDocument; + UnownedPtr m_pFormDict; + std::map> + m_ControlMap; + std::unique_ptr m_pFieldTree; + ByteString m_bsEncoding; + UnownedPtr m_pFormNotify; +}; + +#endif // CORE_FPDFDOC_CPDF_INTERACTIVEFORM_H_ diff --git a/core/fpdfdoc/cpdf_interform.cpp b/core/fpdfdoc/cpdf_interform.cpp deleted file mode 100644 index 5e9e5e51b0..0000000000 --- a/core/fpdfdoc/cpdf_interform.cpp +++ /dev/null @@ -1,1066 +0,0 @@ -// Copyright 2016 PDFium Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com - -#include "core/fpdfdoc/cpdf_interform.h" - -#include -#include - -#include "constants/stream_dict_common.h" -#include "core/fpdfapi/font/cpdf_font.h" -#include "core/fpdfapi/font/cpdf_fontencoding.h" -#include "core/fpdfapi/page/cpdf_page.h" -#include "core/fpdfapi/parser/cfdf_document.h" -#include "core/fpdfapi/parser/cpdf_array.h" -#include "core/fpdfapi/parser/cpdf_dictionary.h" -#include "core/fpdfapi/parser/cpdf_document.h" -#include "core/fpdfapi/parser/cpdf_name.h" -#include "core/fpdfapi/parser/cpdf_reference.h" -#include "core/fpdfapi/parser/cpdf_string.h" -#include "core/fpdfapi/parser/fpdf_parser_utility.h" -#include "core/fpdfdoc/cpdf_filespec.h" -#include "core/fpdfdoc/cpdf_formcontrol.h" -#include "core/fxcrt/fx_codepage.h" -#include "core/fxge/cfx_substfont.h" -#include "core/fxge/fx_font.h" -#include "third_party/base/ptr_util.h" -#include "third_party/base/stl_util.h" - -namespace { - -const int nMaxRecursion = 32; - -ByteString GenerateNewFontResourceName(const CPDF_Dictionary* pResDict, - const ByteString& csPrefix) { - static const char kDummyFontName[] = "ZiTi"; - ByteString csStr = csPrefix; - if (csStr.IsEmpty()) - csStr = kDummyFontName; - - const size_t szCount = csStr.GetLength(); - size_t m = 0; - ByteString csTmp; - while (m < strlen(kDummyFontName) && m < szCount) - csTmp += csStr[m++]; - while (m < strlen(kDummyFontName)) { - csTmp += '0' + m % 10; - m++; - } - - const CPDF_Dictionary* pDict = pResDict->GetDictFor("Font"); - ASSERT(pDict); - - int num = 0; - ByteString bsNum; - while (true) { - ByteString csKey = csTmp + bsNum; - if (!pDict->KeyExist(csKey)) - return csKey; - if (m < szCount) - csTmp += csStr[m++]; - else - bsNum = ByteString::Format("%d", num++); - - m++; - } - return csTmp; -} - -void AddFont(CPDF_Dictionary*& pFormDict, - CPDF_Document* pDocument, - const CPDF_Font* pFont, - ByteString* csNameTag); - -void InitDict(CPDF_Dictionary*& pFormDict, CPDF_Document* pDocument) { - if (!pDocument) - return; - - if (!pFormDict) { - pFormDict = pDocument->NewIndirect(); - pDocument->GetRoot()->SetFor("AcroForm", - pFormDict->MakeReference(pDocument)); - } - - ByteString csDA; - if (!pFormDict->KeyExist("DR")) { - ByteString csBaseName; - uint8_t charSet = CPDF_InterForm::GetNativeCharSet(); - CPDF_Font* pFont = CPDF_InterForm::AddStandardFont( - pDocument, CFX_Font::kDefaultAnsiFontName); - if (pFont) - AddFont(pFormDict, pDocument, pFont, &csBaseName); - - if (charSet != FX_CHARSET_ANSI) { - ByteString csFontName = CPDF_InterForm::GetNativeFont(charSet, nullptr); - if (!pFont || csFontName != CFX_Font::kDefaultAnsiFontName) { - pFont = CPDF_InterForm::AddNativeFont(pDocument); - if (pFont) { - csBaseName.clear(); - AddFont(pFormDict, pDocument, pFont, &csBaseName); - } - } - } - if (pFont) - csDA = "/" + PDF_NameEncode(csBaseName) + " 0 Tf"; - } - if (!csDA.IsEmpty()) - csDA += " "; - - csDA += "0 g"; - if (!pFormDict->KeyExist("DA")) - pFormDict->SetNewFor("DA", csDA, false); -} - -CPDF_Font* GetFont(CPDF_Dictionary* pFormDict, - CPDF_Document* pDocument, - const ByteString& csNameTag) { - ByteString csAlias = PDF_NameDecode(csNameTag.AsStringView()); - if (!pFormDict || csAlias.IsEmpty()) - return nullptr; - - CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); - if (!pDR) - return nullptr; - - CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); - if (!pFonts) - return nullptr; - - CPDF_Dictionary* pElement = pFonts->GetDictFor(csAlias); - if (!pElement) - return nullptr; - - if (pElement->GetStringFor("Type") == "Font") - return pDocument->LoadFont(pElement); - return nullptr; -} - -CPDF_Font* GetNativeFont(CPDF_Dictionary* pFormDict, - CPDF_Document* pDocument, - uint8_t charSet, - ByteString* csNameTag) { - if (!pFormDict) - return nullptr; - - CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); - if (!pDR) - return nullptr; - - CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); - if (!pFonts) - return nullptr; - - for (const auto& it : *pFonts) { - const ByteString& csKey = it.first; - if (!it.second) - continue; - - CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); - if (!pElement) - continue; - if (pElement->GetStringFor("Type") != "Font") - continue; - CPDF_Font* pFind = pDocument->LoadFont(pElement); - if (!pFind) - continue; - - CFX_SubstFont* pSubst = pFind->GetSubstFont(); - if (!pSubst) - continue; - - if (pSubst->m_Charset == static_cast(charSet)) { - *csNameTag = csKey; - return pFind; - } - } - return nullptr; -} - -bool FindFont(CPDF_Dictionary* pFormDict, - const CPDF_Font* pFont, - ByteString* csNameTag) { - if (!pFormDict || !pFont) - return false; - - CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); - if (!pDR) - return false; - - CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); - if (!pFonts) - return false; - - for (const auto& it : *pFonts) { - const ByteString& csKey = it.first; - if (!it.second) - continue; - CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); - if (!pElement) - continue; - if (pElement->GetStringFor("Type") != "Font") - continue; - if (pFont->GetFontDict() == pElement) { - *csNameTag = csKey; - return true; - } - } - return false; -} - -bool FindFont(CPDF_Dictionary* pFormDict, - CPDF_Document* pDocument, - ByteString csFontName, - CPDF_Font*& pFont, - ByteString* csNameTag) { - if (!pFormDict) - return false; - - CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); - if (!pDR) - return false; - - CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); - if (!pFonts) - return false; - - if (csFontName.GetLength() > 0) - csFontName.Remove(' '); - - for (const auto& it : *pFonts) { - const ByteString& csKey = it.first; - if (!it.second) - continue; - - CPDF_Dictionary* pElement = ToDictionary(it.second->GetDirect()); - if (!pElement) - continue; - if (pElement->GetStringFor("Type") != "Font") - continue; - pFont = pDocument->LoadFont(pElement); - if (!pFont) - continue; - - ByteString csBaseFont = pFont->GetBaseFont(); - csBaseFont.Remove(' '); - if (csBaseFont == csFontName) { - *csNameTag = csKey; - return true; - } - } - return false; -} - -void AddFont(CPDF_Dictionary*& pFormDict, - CPDF_Document* pDocument, - const CPDF_Font* pFont, - ByteString* csNameTag) { - if (!pFont) - return; - if (!pFormDict) - InitDict(pFormDict, pDocument); - - ByteString csTag; - if (FindFont(pFormDict, pFont, &csTag)) { - *csNameTag = std::move(csTag); - return; - } - if (!pFormDict) - InitDict(pFormDict, pDocument); - - CPDF_Dictionary* pDR = pFormDict->GetDictFor("DR"); - if (!pDR) - pDR = pFormDict->SetNewFor("DR"); - - CPDF_Dictionary* pFonts = pDR->GetDictFor("Font"); - if (!pFonts) - pFonts = pDR->SetNewFor("Font"); - - if (csNameTag->IsEmpty()) - *csNameTag = pFont->GetBaseFont(); - - csNameTag->Remove(' '); - *csNameTag = GenerateNewFontResourceName(pDR, *csNameTag); - pFonts->SetFor(*csNameTag, pFont->GetFontDict()->MakeReference(pDocument)); -} - -CPDF_Font* AddNativeFont(CPDF_Dictionary*& pFormDict, - CPDF_Document* pDocument, - uint8_t charSet, - ByteString* csNameTag) { - if (!pFormDict) - InitDict(pFormDict, pDocument); - - ByteString csTemp; - CPDF_Font* pFont = GetNativeFont(pFormDict, pDocument, charSet, &csTemp); - if (pFont) { - *csNameTag = std::move(csTemp); - return pFont; - } - ByteString csFontName = CPDF_InterForm::GetNativeFont(charSet, nullptr); - if (!csFontName.IsEmpty() && - FindFont(pFormDict, pDocument, csFontName, pFont, csNameTag)) { - return pFont; - } - pFont = CPDF_InterForm::AddNativeFont(charSet, pDocument); - if (pFont) - AddFont(pFormDict, pDocument, pFont, csNameTag); - - return pFont; -} - -class CFieldNameExtractor { - public: - explicit CFieldNameExtractor(const WideString& full_name) - : m_FullName(full_name) { - m_pCur = m_FullName.c_str(); - m_pEnd = m_pCur + m_FullName.GetLength(); - } - - void GetNext(const wchar_t*& pSubName, size_t& size) { - pSubName = m_pCur; - while (m_pCur < m_pEnd && m_pCur[0] != L'.') - m_pCur++; - - size = static_cast(m_pCur - pSubName); - if (m_pCur < m_pEnd && m_pCur[0] == L'.') - m_pCur++; - } - - protected: - WideString m_FullName; - const wchar_t* m_pCur; - const wchar_t* m_pEnd; -}; - -#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ -struct PDF_FONTDATA { - bool bFind; - LOGFONTA lf; -}; - -static int CALLBACK EnumFontFamExProc(ENUMLOGFONTEXA* lpelfe, - NEWTEXTMETRICEX* lpntme, - DWORD FontType, - LPARAM lParam) { - if (FontType != 0x004 || strchr(lpelfe->elfLogFont.lfFaceName, '@')) - return 1; - - PDF_FONTDATA* pData = (PDF_FONTDATA*)lParam; - memcpy(&pData->lf, &lpelfe->elfLogFont, sizeof(LOGFONTA)); - pData->bFind = true; - return 0; -} - -bool RetrieveSpecificFont(LOGFONTA& lf) { - PDF_FONTDATA fd; - memset(&fd, 0, sizeof(PDF_FONTDATA)); - HDC hDC = ::GetDC(nullptr); - EnumFontFamiliesExA(hDC, &lf, (FONTENUMPROCA)EnumFontFamExProc, (LPARAM)&fd, - 0); - ::ReleaseDC(nullptr, hDC); - if (fd.bFind) - memcpy(&lf, &fd.lf, sizeof(LOGFONTA)); - - return fd.bFind; -} - -bool RetrieveSpecificFont(uint8_t charSet, - uint8_t pitchAndFamily, - LPCSTR pcsFontName, - LOGFONTA& lf) { - memset(&lf, 0, sizeof(LOGFONTA)); - lf.lfCharSet = charSet; - lf.lfPitchAndFamily = pitchAndFamily; - if (pcsFontName) { - // TODO(dsinclair): Should this be strncpy? - // NOLINTNEXTLINE(runtime/printf) - strcpy(lf.lfFaceName, pcsFontName); - } - return RetrieveSpecificFont(lf); -} -#endif // _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ - -} // namespace - -class CFieldTree { - public: - class Node { - public: - Node() : m_pField(nullptr), m_level(0) {} - Node(const WideString& short_name, int level) - : m_ShortName(short_name), m_level(level) {} - ~Node() {} - - void AddChildNode(std::unique_ptr pNode) { - m_Children.push_back(std::move(pNode)); - } - - size_t GetChildrenCount() const { return m_Children.size(); } - - Node* GetChildAt(size_t i) { return m_Children[i].get(); } - const Node* GetChildAt(size_t i) const { return m_Children[i].get(); } - - CPDF_FormField* GetFieldAtIndex(size_t index) { - size_t nFieldsToGo = index; - return GetFieldInternal(&nFieldsToGo); - } - - size_t CountFields() const { return CountFieldsInternal(); } - - void SetField(std::unique_ptr pField) { - m_pField = std::move(pField); - } - - CPDF_FormField* GetField() const { return m_pField.get(); } - WideString GetShortName() const { return m_ShortName; } - int GetLevel() const { return m_level; } - - private: - CPDF_FormField* GetFieldInternal(size_t* pFieldsToGo) { - if (m_pField) { - if (*pFieldsToGo == 0) - return m_pField.get(); - - --*pFieldsToGo; - } - for (size_t i = 0; i < GetChildrenCount(); ++i) { - CPDF_FormField* pField = GetChildAt(i)->GetFieldInternal(pFieldsToGo); - if (pField) - return pField; - } - return nullptr; - } - - size_t CountFieldsInternal() const { - size_t count = 0; - if (m_pField) - ++count; - - for (size_t i = 0; i < GetChildrenCount(); ++i) - count += GetChildAt(i)->CountFieldsInternal(); - return count; - } - - std::vector> m_Children; - WideString m_ShortName; - std::unique_ptr m_pField; - const int m_level; - }; - - CFieldTree(); - ~CFieldTree(); - - bool SetField(const WideString& full_name, - std::unique_ptr pField); - CPDF_FormField* GetField(const WideString& full_name); - - Node* FindNode(const WideString& full_name); - Node* AddChild(Node* pParent, const WideString& short_name); - - Node* Lookup(Node* pParent, const WideString& short_name); - - Node m_Root; -}; - -CFieldTree::CFieldTree() {} - -CFieldTree::~CFieldTree() {} - -CFieldTree::Node* CFieldTree::AddChild(Node* pParent, - const WideString& short_name) { - if (!pParent) - return nullptr; - - int level = pParent->GetLevel() + 1; - if (level > nMaxRecursion) - return nullptr; - - auto pNew = pdfium::MakeUnique(short_name, pParent->GetLevel() + 1); - Node* pChild = pNew.get(); - pParent->AddChildNode(std::move(pNew)); - return pChild; -} - -CFieldTree::Node* CFieldTree::Lookup(Node* pParent, - const WideString& short_name) { - if (!pParent) - return nullptr; - - for (size_t i = 0; i < pParent->GetChildrenCount(); ++i) { - Node* pNode = pParent->GetChildAt(i); - if (pNode->GetShortName() == short_name) - return pNode; - } - return nullptr; -} - -bool CFieldTree::SetField(const WideString& full_name, - std::unique_ptr pField) { - if (full_name.IsEmpty()) - return false; - - CFieldNameExtractor name_extractor(full_name); - const wchar_t* pName; - size_t nLength; - name_extractor.GetNext(pName, nLength); - Node* pNode = &m_Root; - Node* pLast = nullptr; - while (nLength > 0) { - pLast = pNode; - WideString name = WideString(pName, nLength); - pNode = Lookup(pLast, name); - if (!pNode) - pNode = AddChild(pLast, name); - if (!pNode) - return false; - - name_extractor.GetNext(pName, nLength); - } - if (pNode == &m_Root) - return false; - - pNode->SetField(std::move(pField)); - return true; -} - -CPDF_FormField* CFieldTree::GetField(const WideString& full_name) { - if (full_name.IsEmpty()) - return nullptr; - - CFieldNameExtractor name_extractor(full_name); - const wchar_t* pName; - size_t nLength; - name_extractor.GetNext(pName, nLength); - Node* pNode = &m_Root; - Node* pLast = nullptr; - while (nLength > 0 && pNode) { - pLast = pNode; - WideString name = WideString(pName, nLength); - pNode = Lookup(pLast, name); - name_extractor.GetNext(pName, nLength); - } - return pNode ? pNode->GetField() : nullptr; -} - -CFieldTree::Node* CFieldTree::FindNode(const WideString& full_name) { - if (full_name.IsEmpty()) - return nullptr; - - CFieldNameExtractor name_extractor(full_name); - const wchar_t* pName; - size_t nLength; - name_extractor.GetNext(pName, nLength); - Node* pNode = &m_Root; - Node* pLast = nullptr; - while (nLength > 0 && pNode) { - pLast = pNode; - WideString name = WideString(pName, nLength); - pNode = Lookup(pLast, name); - name_extractor.GetNext(pName, nLength); - } - return pNode; -} - -CPDF_Font* AddNativeInterFormFont(CPDF_Dictionary*& pFormDict, - CPDF_Document* pDocument, - ByteString* csNameTag) { - uint8_t charSet = CPDF_InterForm::GetNativeCharSet(); - return AddNativeFont(pFormDict, pDocument, charSet, csNameTag); -} - -// static -uint8_t CPDF_InterForm::GetNativeCharSet() { - return FX_GetCharsetFromCodePage(FXSYS_GetACP()); -} - -CPDF_InterForm::CPDF_InterForm(CPDF_Document* pDocument) - : m_pDocument(pDocument), m_pFieldTree(pdfium::MakeUnique()) { - CPDF_Dictionary* pRoot = m_pDocument->GetRoot(); - if (!pRoot) - return; - - m_pFormDict = pRoot->GetDictFor("AcroForm"); - if (!m_pFormDict) - return; - - CPDF_Array* pFields = m_pFormDict->GetArrayFor("Fields"); - if (!pFields) - return; - - for (size_t i = 0; i < pFields->GetCount(); ++i) - LoadField(pFields->GetDictAt(i), 0); -} - -CPDF_InterForm::~CPDF_InterForm() {} - -bool CPDF_InterForm::s_bUpdateAP = true; - -bool CPDF_InterForm::IsUpdateAPEnabled() { - return s_bUpdateAP; -} - -void CPDF_InterForm::SetUpdateAP(bool bUpdateAP) { - s_bUpdateAP = bUpdateAP; -} - -CPDF_Font* CPDF_InterForm::AddStandardFont(CPDF_Document* pDocument, - ByteString csFontName) { - if (!pDocument || csFontName.IsEmpty()) - return nullptr; - - if (csFontName == "ZapfDingbats") - return pDocument->AddStandardFont(csFontName.c_str(), nullptr); - - CPDF_FontEncoding encoding(PDFFONT_ENCODING_WINANSI); - return pDocument->AddStandardFont(csFontName.c_str(), &encoding); -} - -ByteString CPDF_InterForm::GetNativeFont(uint8_t charSet, void* pLogFont) { - ByteString csFontName; -#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ - LOGFONTA lf = {}; - if (charSet == FX_CHARSET_ANSI) { - csFontName = CFX_Font::kDefaultAnsiFontName; - return csFontName; - } - bool bRet = false; - const ByteString default_font_name = - CFX_Font::GetDefaultFontNameByCharset(charSet); - if (!default_font_name.IsEmpty()) { - bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, - default_font_name.c_str(), lf); - } - if (!bRet) { - bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, - CFX_Font::kUniversalDefaultFontName, lf); - } - if (!bRet) { - bRet = RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, - "Microsoft Sans Serif", lf); - } - if (!bRet) { - bRet = - RetrieveSpecificFont(charSet, DEFAULT_PITCH | FF_DONTCARE, nullptr, lf); - } - if (bRet) { - if (pLogFont) - memcpy(pLogFont, &lf, sizeof(LOGFONTA)); - - csFontName = lf.lfFaceName; - return csFontName; - } -#endif - return csFontName; -} - -CPDF_Font* CPDF_InterForm::AddNativeFont(uint8_t charSet, - CPDF_Document* pDocument) { - if (!pDocument) - return nullptr; - -#if _FX_PLATFORM_ == _FX_PLATFORM_WINDOWS_ - LOGFONTA lf; - ByteString csFontName = GetNativeFont(charSet, &lf); - if (!csFontName.IsEmpty()) { - if (csFontName == CFX_Font::kDefaultAnsiFontName) - return AddStandardFont(pDocument, csFontName); - return pDocument->AddWindowsFont(&lf); - } -#endif - return nullptr; -} - -CPDF_Font* CPDF_InterForm::AddNativeFont(CPDF_Document* pDocument) { - return pDocument ? AddNativeFont(GetNativeCharSet(), pDocument) : nullptr; -} - -size_t CPDF_InterForm::CountFields(const WideString& csFieldName) const { - if (csFieldName.IsEmpty()) - return m_pFieldTree->m_Root.CountFields(); - - CFieldTree::Node* pNode = m_pFieldTree->FindNode(csFieldName); - return pNode ? pNode->CountFields() : 0; -} - -CPDF_FormField* CPDF_InterForm::GetField(uint32_t index, - const WideString& csFieldName) const { - if (csFieldName.IsEmpty()) - return m_pFieldTree->m_Root.GetFieldAtIndex(index); - - CFieldTree::Node* pNode = m_pFieldTree->FindNode(csFieldName); - return pNode ? pNode->GetFieldAtIndex(index) : nullptr; -} - -CPDF_FormField* CPDF_InterForm::GetFieldByDict( - CPDF_Dictionary* pFieldDict) const { - if (!pFieldDict) - return nullptr; - - WideString csWName = FPDF_GetFullName(pFieldDict); - return m_pFieldTree->GetField(csWName); -} - -CPDF_FormControl* CPDF_InterForm::GetControlAtPoint(CPDF_Page* pPage, - const CFX_PointF& point, - - int* z_order) const { - CPDF_Array* pAnnotList = pPage->GetDict()->GetArrayFor("Annots"); - if (!pAnnotList) - return nullptr; - - for (size_t i = pAnnotList->GetCount(); i > 0; --i) { - size_t annot_index = i - 1; - CPDF_Dictionary* pAnnot = pAnnotList->GetDictAt(annot_index); - if (!pAnnot) - continue; - - const auto it = m_ControlMap.find(pAnnot); - if (it == m_ControlMap.end()) - continue; - - CPDF_FormControl* pControl = it->second.get(); - if (!pControl->GetRect().Contains(point)) - continue; - - if (z_order) - *z_order = static_cast(annot_index); - return pControl; - } - return nullptr; -} - -CPDF_FormControl* CPDF_InterForm::GetControlByDict( - const CPDF_Dictionary* pWidgetDict) const { - const auto it = m_ControlMap.find(pWidgetDict); - return it != m_ControlMap.end() ? it->second.get() : nullptr; -} - -bool CPDF_InterForm::NeedConstructAP() const { - return m_pFormDict && m_pFormDict->GetBooleanFor("NeedAppearances", false); -} - -int CPDF_InterForm::CountFieldsInCalculationOrder() { - if (!m_pFormDict) - return 0; - - CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); - return pArray ? pArray->GetCount() : 0; -} - -CPDF_FormField* CPDF_InterForm::GetFieldInCalculationOrder(int index) { - if (!m_pFormDict || index < 0) - return nullptr; - - CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); - if (!pArray) - return nullptr; - - CPDF_Dictionary* pElement = ToDictionary(pArray->GetDirectObjectAt(index)); - return pElement ? GetFieldByDict(pElement) : nullptr; -} - -int CPDF_InterForm::FindFieldInCalculationOrder(const CPDF_FormField* pField) { - if (!m_pFormDict || !pField) - return -1; - - CPDF_Array* pArray = m_pFormDict->GetArrayFor("CO"); - if (!pArray) - return -1; - - for (size_t i = 0; i < pArray->GetCount(); i++) { - CPDF_Object* pElement = pArray->GetDirectObjectAt(i); - if (pElement == pField->GetDict()) - return i; - } - return -1; -} - -CPDF_Font* CPDF_InterForm::GetFormFont(ByteString csNameTag) const { - return GetFont(m_pFormDict.Get(), m_pDocument.Get(), csNameTag); -} - -CPDF_DefaultAppearance CPDF_InterForm::GetDefaultAppearance() const { - if (!m_pFormDict) - return CPDF_DefaultAppearance(); - return CPDF_DefaultAppearance(m_pFormDict->GetStringFor("DA")); -} - -int CPDF_InterForm::GetFormAlignment() const { - return m_pFormDict ? m_pFormDict->GetIntegerFor("Q", 0) : 0; -} - -void CPDF_InterForm::ResetForm(const std::vector& fields, - bool bIncludeOrExclude, - NotificationOption notify) { - size_t nCount = m_pFieldTree->m_Root.CountFields(); - for (size_t i = 0; i < nCount; ++i) { - CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); - if (!pField) - continue; - - if (bIncludeOrExclude == pdfium::ContainsValue(fields, pField)) - pField->ResetField(notify); - } - if (notify == NotificationOption::kNotify && m_pFormNotify) - m_pFormNotify->AfterFormReset(this); -} - -void CPDF_InterForm::ResetForm(NotificationOption notify) { - size_t nCount = m_pFieldTree->m_Root.CountFields(); - for (size_t i = 0; i < nCount; ++i) { - CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); - if (!pField) - continue; - - pField->ResetField(notify); - } - if (notify == NotificationOption::kNotify && m_pFormNotify) - m_pFormNotify->AfterFormReset(this); -} - -void CPDF_InterForm::LoadField(CPDF_Dictionary* pFieldDict, int nLevel) { - if (nLevel > nMaxRecursion) - return; - if (!pFieldDict) - return; - - uint32_t dwParentObjNum = pFieldDict->GetObjNum(); - CPDF_Array* pKids = pFieldDict->GetArrayFor("Kids"); - if (!pKids) { - AddTerminalField(pFieldDict); - return; - } - - CPDF_Dictionary* pFirstKid = pKids->GetDictAt(0); - if (!pFirstKid) - return; - - if (pFirstKid->KeyExist("T") || pFirstKid->KeyExist("Kids")) { - for (size_t i = 0; i < pKids->GetCount(); i++) { - CPDF_Dictionary* pChildDict = pKids->GetDictAt(i); - if (pChildDict) { - if (pChildDict->GetObjNum() != dwParentObjNum) - LoadField(pChildDict, nLevel + 1); - } - } - } else { - AddTerminalField(pFieldDict); - } -} - -bool CPDF_InterForm::HasXFAForm() const { - return m_pFormDict && m_pFormDict->GetArrayFor("XFA"); -} - -void CPDF_InterForm::FixPageFields(CPDF_Page* pPage) { - CPDF_Dictionary* pPageDict = pPage->GetDict(); - if (!pPageDict) - return; - - CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots"); - if (!pAnnots) - return; - - for (size_t i = 0; i < pAnnots->GetCount(); i++) { - CPDF_Dictionary* pAnnot = pAnnots->GetDictAt(i); - if (pAnnot && pAnnot->GetStringFor("Subtype") == "Widget") - LoadField(pAnnot, 0); - } -} - -void CPDF_InterForm::AddTerminalField(CPDF_Dictionary* pFieldDict) { - if (!pFieldDict->KeyExist("FT")) { - // Key "FT" is required for terminal fields, it is also inheritable. - CPDF_Dictionary* pParentDict = pFieldDict->GetDictFor("Parent"); - if (!pParentDict || !pParentDict->KeyExist("FT")) - return; - } - - CPDF_Dictionary* pDict = pFieldDict; - WideString csWName = FPDF_GetFullName(pFieldDict); - if (csWName.IsEmpty()) - return; - - CPDF_FormField* pField = nullptr; - pField = m_pFieldTree->GetField(csWName); - if (!pField) { - CPDF_Dictionary* pParent = pFieldDict; - if (!pFieldDict->KeyExist("T") && - pFieldDict->GetStringFor("Subtype") == "Widget") { - pParent = pFieldDict->GetDictFor("Parent"); - if (!pParent) - pParent = pFieldDict; - } - - if (pParent && pParent != pFieldDict && !pParent->KeyExist("FT")) { - if (pFieldDict->KeyExist("FT")) { - CPDF_Object* pFTValue = pFieldDict->GetDirectObjectFor("FT"); - if (pFTValue) - pParent->SetFor("FT", pFTValue->Clone()); - } - - if (pFieldDict->KeyExist("Ff")) { - CPDF_Object* pFfValue = pFieldDict->GetDirectObjectFor("Ff"); - if (pFfValue) - pParent->SetFor("Ff", pFfValue->Clone()); - } - } - - auto newField = pdfium::MakeUnique(this, pParent); - pField = newField.get(); - CPDF_Object* pTObj = pDict->GetObjectFor("T"); - if (ToReference(pTObj)) { - std::unique_ptr pClone = pTObj->CloneDirectObject(); - if (pClone) - pDict->SetFor("T", std::move(pClone)); - else - pDict->SetNewFor("T", ""); - } - if (!m_pFieldTree->SetField(csWName, std::move(newField))) - return; - } - - CPDF_Array* pKids = pFieldDict->GetArrayFor("Kids"); - if (pKids) { - for (size_t i = 0; i < pKids->GetCount(); i++) { - CPDF_Dictionary* pKid = pKids->GetDictAt(i); - if (!pKid) - continue; - if (pKid->GetStringFor("Subtype") != "Widget") - continue; - - AddControl(pField, pKid); - } - } else { - if (pFieldDict->GetStringFor("Subtype") == "Widget") - AddControl(pField, pFieldDict); - } -} - -CPDF_FormControl* CPDF_InterForm::AddControl(CPDF_FormField* pField, - CPDF_Dictionary* pWidgetDict) { - const auto it = m_ControlMap.find(pWidgetDict); - if (it != m_ControlMap.end()) - return it->second.get(); - - auto pNew = pdfium::MakeUnique(pField, pWidgetDict); - CPDF_FormControl* pControl = pNew.get(); - m_ControlMap[pWidgetDict] = std::move(pNew); - pField->AddFormControl(pControl); - return pControl; -} - -bool CPDF_InterForm::CheckRequiredFields( - const std::vector* fields, - bool bIncludeOrExclude) const { - size_t nCount = m_pFieldTree->m_Root.CountFields(); - for (size_t i = 0; i < nCount; ++i) { - CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); - if (!pField) - continue; - - int32_t iType = pField->GetType(); - if (iType == CPDF_FormField::PushButton || - iType == CPDF_FormField::CheckBox || iType == CPDF_FormField::ListBox) { - continue; - } - if (pField->IsNoExport()) - continue; - - bool bFind = true; - if (fields) - bFind = pdfium::ContainsValue(*fields, pField); - if (bIncludeOrExclude == bFind) { - const CPDF_Dictionary* pFieldDict = pField->GetDict(); - if (pField->IsRequired() && pFieldDict->GetStringFor("V").IsEmpty()) - return false; - } - } - return true; -} - -std::unique_ptr CPDF_InterForm::ExportToFDF( - const WideString& pdf_path, - bool bSimpleFileSpec) const { - std::vector fields; - size_t nCount = m_pFieldTree->m_Root.CountFields(); - for (size_t i = 0; i < nCount; ++i) - fields.push_back(m_pFieldTree->m_Root.GetFieldAtIndex(i)); - return ExportToFDF(pdf_path, fields, true, bSimpleFileSpec); -} - -std::unique_ptr CPDF_InterForm::ExportToFDF( - const WideString& pdf_path, - const std::vector& fields, - bool bIncludeOrExclude, - bool bSimpleFileSpec) const { - std::unique_ptr pDoc = CFDF_Document::CreateNewDoc(); - if (!pDoc) - return nullptr; - - CPDF_Dictionary* pMainDict = pDoc->GetRoot()->GetDictFor("FDF"); - if (!pdf_path.IsEmpty()) { - if (bSimpleFileSpec) { - WideString wsFilePath = CPDF_FileSpec::EncodeFileName(pdf_path); - pMainDict->SetNewFor(pdfium::stream::kF, - wsFilePath.ToDefANSI(), false); - pMainDict->SetNewFor("UF", PDF_EncodeText(wsFilePath), - false); - } else { - auto pNewDict = - pdfium::MakeUnique(pDoc->GetByteStringPool()); - pNewDict->SetNewFor("Type", "Filespec"); - CPDF_FileSpec filespec(pNewDict.get()); - filespec.SetFileName(pdf_path); - pMainDict->SetFor("F", std::move(pNewDict)); - } - } - - CPDF_Array* pFields = pMainDict->SetNewFor("Fields"); - size_t nCount = m_pFieldTree->m_Root.CountFields(); - for (size_t i = 0; i < nCount; ++i) { - CPDF_FormField* pField = m_pFieldTree->m_Root.GetFieldAtIndex(i); - if (!pField || pField->GetType() == CPDF_FormField::PushButton) - continue; - - uint32_t dwFlags = pField->GetFieldFlags(); - if (dwFlags & 0x04) - continue; - - if (bIncludeOrExclude != pdfium::ContainsValue(fields, pField)) - continue; - - if ((dwFlags & 0x02) != 0 && - pField->GetDict()->GetStringFor("V").IsEmpty()) { - continue; - } - - WideString fullname = FPDF_GetFullName(pField->GetFieldDict()); - auto pFieldDict = - pdfium::MakeUnique(pDoc->GetByteStringPool()); - pFieldDict->SetNewFor("T", fullname); - if (pField->GetType() == CPDF_FormField::CheckBox || - pField->GetType() == CPDF_FormField::RadioButton) { - WideString csExport = pField->GetCheckValue(false); - ByteString csBExport = PDF_EncodeText(csExport); - CPDF_Object* pOpt = FPDF_GetFieldAttr(pField->GetDict(), "Opt"); - if (pOpt) - pFieldDict->SetNewFor("V", csBExport, false); - else - pFieldDict->SetNewFor("V", csBExport); - } else { - CPDF_Object* pV = FPDF_GetFieldAttr(pField->GetDict(), "V"); - if (pV) - pFieldDict->SetFor("V", pV->CloneDirectObject()); - } - pFields->Add(std::move(pFieldDict)); - } - return pDoc; -} - -void CPDF_InterForm::SetFormNotify(IPDF_FormNotify* pNotify) { - m_pFormNotify = pNotify; -} diff --git a/core/fpdfdoc/cpdf_interform.h b/core/fpdfdoc/cpdf_interform.h deleted file mode 100644 index 97d8ac1e72..0000000000 --- a/core/fpdfdoc/cpdf_interform.h +++ /dev/null @@ -1,111 +0,0 @@ -// Copyright 2016 PDFium Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com - -#ifndef CORE_FPDFDOC_CPDF_INTERFORM_H_ -#define CORE_FPDFDOC_CPDF_INTERFORM_H_ - -#include -#include -#include - -#include "core/fpdfapi/parser/fpdf_parser_decode.h" -#include "core/fpdfdoc/cpdf_defaultappearance.h" -#include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fxcrt/fx_string.h" -#include "core/fxcrt/fx_system.h" -#include "core/fxcrt/unowned_ptr.h" - -class CFieldTree; -class CFDF_Document; -class CPDF_Document; -class CPDF_Dictionary; -class CPDF_Font; -class CPDF_FormControl; -class CPDF_Object; -class CPDF_Page; -class IPDF_FormNotify; - -CPDF_Font* AddNativeInterFormFont(CPDF_Dictionary*& pFormDict, - CPDF_Document* pDocument, - ByteString* csNameTag); - -class CPDF_InterForm { - public: - explicit CPDF_InterForm(CPDF_Document* pDocument); - ~CPDF_InterForm(); - - static void SetUpdateAP(bool bUpdateAP); - static bool IsUpdateAPEnabled(); - static CPDF_Font* AddStandardFont(CPDF_Document* pDocument, - ByteString csFontName); - static ByteString GetNativeFont(uint8_t iCharSet, void* pLogFont); - static uint8_t GetNativeCharSet(); - static CPDF_Font* AddNativeFont(uint8_t iCharSet, CPDF_Document* pDocument); - static CPDF_Font* AddNativeFont(CPDF_Document* pDocument); - - size_t CountFields(const WideString& csFieldName) const; - CPDF_FormField* GetField(uint32_t index, const WideString& csFieldName) const; - CPDF_FormField* GetFieldByDict(CPDF_Dictionary* pFieldDict) const; - - CPDF_FormControl* GetControlAtPoint(CPDF_Page* pPage, - const CFX_PointF& point, - int* z_order) const; - CPDF_FormControl* GetControlByDict(const CPDF_Dictionary* pWidgetDict) const; - - bool NeedConstructAP() const; - int CountFieldsInCalculationOrder(); - CPDF_FormField* GetFieldInCalculationOrder(int index); - int FindFieldInCalculationOrder(const CPDF_FormField* pField); - - CPDF_Font* GetFormFont(ByteString csNameTag) const; - CPDF_DefaultAppearance GetDefaultAppearance() const; - int GetFormAlignment() const; - - bool CheckRequiredFields(const std::vector* fields, - bool bIncludeOrExclude) const; - - std::unique_ptr ExportToFDF(const WideString& pdf_path, - bool bSimpleFileSpec) const; - - std::unique_ptr ExportToFDF( - const WideString& pdf_path, - const std::vector& fields, - bool bIncludeOrExclude, - bool bSimpleFileSpec) const; - - void ResetForm(NotificationOption notify); - - // TODO(tsepez): Use a span. - void ResetForm(const std::vector& fields, - bool bIncludeOrExclude, - NotificationOption notify); - - void SetFormNotify(IPDF_FormNotify* pNotify); - bool HasXFAForm() const; - void FixPageFields(CPDF_Page* pPage); - - IPDF_FormNotify* GetFormNotify() const { return m_pFormNotify.Get(); } - CPDF_Document* GetDocument() const { return m_pDocument.Get(); } - CPDF_Dictionary* GetFormDict() const { return m_pFormDict.Get(); } - - private: - void LoadField(CPDF_Dictionary* pFieldDict, int nLevel); - void AddTerminalField(CPDF_Dictionary* pFieldDict); - CPDF_FormControl* AddControl(CPDF_FormField* pField, - CPDF_Dictionary* pWidgetDict); - - static bool s_bUpdateAP; - - UnownedPtr const m_pDocument; - UnownedPtr m_pFormDict; - std::map> - m_ControlMap; - std::unique_ptr m_pFieldTree; - ByteString m_bsEncoding; - UnownedPtr m_pFormNotify; -}; - -#endif // CORE_FPDFDOC_CPDF_INTERFORM_H_ diff --git a/core/fpdfdoc/cpvt_fontmap.cpp b/core/fpdfdoc/cpvt_fontmap.cpp index 16ce4403c6..7d414f6c8d 100644 --- a/core/fpdfdoc/cpvt_fontmap.cpp +++ b/core/fpdfdoc/cpvt_fontmap.cpp @@ -10,7 +10,7 @@ #include "core/fpdfapi/parser/cpdf_dictionary.h" #include "core/fpdfapi/parser/cpdf_document.h" #include "core/fpdfapi/parser/cpdf_reference.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fxcrt/fx_codepage.h" #include "third_party/base/logging.h" diff --git a/fpdfsdk/cpdfsdk_actionhandler.cpp b/fpdfsdk/cpdfsdk_actionhandler.cpp index f98585f2a1..8093972e18 100644 --- a/fpdfsdk/cpdfsdk_actionhandler.cpp +++ b/fpdfsdk/cpdfsdk_actionhandler.cpp @@ -11,10 +11,10 @@ #include "core/fpdfapi/parser/cpdf_array.h" #include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" #include "fpdfsdk/cpdfsdk_helpers.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fxjs/ijs_event_context.h" #include "fxjs/ijs_runtime.h" #include "third_party/base/logging.h" diff --git a/fpdfsdk/cpdfsdk_baannothandler.cpp b/fpdfsdk/cpdfsdk_baannothandler.cpp index 93d3e46fdf..168c806e07 100644 --- a/fpdfsdk/cpdfsdk_baannothandler.cpp +++ b/fpdfsdk/cpdfsdk_baannothandler.cpp @@ -11,7 +11,7 @@ #include "core/fpdfapi/page/cpdf_page.h" #include "core/fpdfapi/parser/cpdf_document.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "fpdfsdk/cpdfsdk_annot.h" #include "fpdfsdk/cpdfsdk_baannot.h" #include "fpdfsdk/cpdfsdk_pageview.h" diff --git a/fpdfsdk/cpdfsdk_formfillenvironment.cpp b/fpdfsdk/cpdfsdk_formfillenvironment.cpp index 52dfb526eb..8f490ca2bc 100644 --- a/fpdfsdk/cpdfsdk_formfillenvironment.cpp +++ b/fpdfsdk/cpdfsdk_formfillenvironment.cpp @@ -14,7 +14,7 @@ #include "core/fpdfdoc/cpdf_docjsactions.h" #include "fpdfsdk/cpdfsdk_actionhandler.h" #include "fpdfsdk/cpdfsdk_annothandlermgr.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_widget.h" #include "fpdfsdk/formfiller/cffl_interactiveformfiller.h" diff --git a/fpdfsdk/cpdfsdk_helpers.cpp b/fpdfsdk/cpdfsdk_helpers.cpp index dc8dc80cdc..6a0cf85482 100644 --- a/fpdfsdk/cpdfsdk_helpers.cpp +++ b/fpdfsdk/cpdfsdk_helpers.cpp @@ -14,7 +14,7 @@ #include "core/fpdfapi/parser/cpdf_document.h" #include "core/fpdfapi/parser/cpdf_stream_acc.h" #include "core/fpdfdoc/cpdf_annot.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpdf_metadata.h" #include "public/fpdf_ext.h" diff --git a/fpdfsdk/cpdfsdk_interactiveform.cpp b/fpdfsdk/cpdfsdk_interactiveform.cpp new file mode 100644 index 0000000000..843d1e99e0 --- /dev/null +++ b/fpdfsdk/cpdfsdk_interactiveform.cpp @@ -0,0 +1,672 @@ +// Copyright 2016 PDFium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com + +#include "fpdfsdk/cpdfsdk_interactiveform.h" + +#include +#include +#include +#include +#include +#include + +#include "core/fpdfapi/page/cpdf_page.h" +#include "core/fpdfapi/parser/cfdf_document.h" +#include "core/fpdfapi/parser/cpdf_array.h" +#include "core/fpdfapi/parser/cpdf_dictionary.h" +#include "core/fpdfapi/parser/cpdf_document.h" +#include "core/fpdfapi/parser/cpdf_stream.h" +#include "core/fpdfdoc/cpdf_actionfields.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" +#include "core/fxcrt/autorestorer.h" +#include "core/fxge/cfx_graphstatedata.h" +#include "core/fxge/cfx_pathdata.h" +#include "fpdfsdk/cpdfsdk_actionhandler.h" +#include "fpdfsdk/cpdfsdk_annot.h" +#include "fpdfsdk/cpdfsdk_annotiterator.h" +#include "fpdfsdk/cpdfsdk_formfillenvironment.h" +#include "fpdfsdk/cpdfsdk_helpers.h" +#include "fpdfsdk/cpdfsdk_pageview.h" +#include "fpdfsdk/cpdfsdk_widget.h" +#include "fpdfsdk/formfiller/cffl_formfiller.h" +#include "fpdfsdk/ipdfsdk_annothandler.h" +#include "fxjs/ijs_event_context.h" +#include "fxjs/ijs_runtime.h" +#include "third_party/base/ptr_util.h" +#include "third_party/base/stl_util.h" + +#ifdef PDF_ENABLE_XFA +#include "fpdfsdk/cpdfsdk_xfawidget.h" +#include "fpdfsdk/fpdfxfa/cpdfxfa_context.h" +#include "fpdfsdk/fpdfxfa/cxfa_fwladaptertimermgr.h" +#include "xfa/fxfa/cxfa_eventparam.h" +#include "xfa/fxfa/cxfa_ffdocview.h" +#include "xfa/fxfa/cxfa_ffwidget.h" +#include "xfa/fxfa/cxfa_ffwidgethandler.h" +#endif // PDF_ENABLE_XFA + +namespace { + +constexpr uint32_t kWhiteBGR = FXSYS_BGR(255, 255, 255); + +bool IsFormFieldTypeComboOrText(FormFieldType fieldType) { + switch (fieldType) { + case FormFieldType::kComboBox: + case FormFieldType::kTextField: + return true; + default: + return false; + } +} + +#ifdef PDF_ENABLE_XFA +bool IsFormFieldTypeXFA(FormFieldType fieldType) { + switch (fieldType) { + case FormFieldType::kXFA: + case FormFieldType::kXFA_CheckBox: + case FormFieldType::kXFA_ComboBox: + case FormFieldType::kXFA_ImageField: + case FormFieldType::kXFA_ListBox: + case FormFieldType::kXFA_PushButton: + case FormFieldType::kXFA_Signature: + case FormFieldType::kXFA_TextField: + return true; + default: + return false; + } +} +#endif // PDF_ENABLE_XFA + +bool FDFToURLEncodedData(std::vector* pBuffer) { + std::unique_ptr pFDF = CFDF_Document::ParseMemory(*pBuffer); + if (!pFDF) + return true; + + CPDF_Dictionary* pMainDict = pFDF->GetRoot()->GetDictFor("FDF"); + if (!pMainDict) + return false; + + CPDF_Array* pFields = pMainDict->GetArrayFor("Fields"); + if (!pFields) + return false; + + std::ostringstream fdfEncodedData; + for (uint32_t i = 0; i < pFields->GetCount(); i++) { + CPDF_Dictionary* pField = pFields->GetDictAt(i); + if (!pField) + continue; + WideString name; + name = pField->GetUnicodeTextFor("T"); + ByteString name_b = name.ToDefANSI(); + ByteString csBValue = pField->GetStringFor("V"); + WideString csWValue = PDF_DecodeText(csBValue); + ByteString csValue_b = csWValue.ToDefANSI(); + fdfEncodedData << name_b << "=" << csValue_b; + if (i != pFields->GetCount() - 1) + fdfEncodedData << "&"; + } + + size_t nBufSize = fdfEncodedData.tellp(); + if (nBufSize <= 0) + return false; + + pBuffer->resize(nBufSize); + memcpy(pBuffer->data(), fdfEncodedData.str().c_str(), nBufSize); + return true; +} + +} // namespace + +CPDFSDK_InterForm::CPDFSDK_InterForm(CPDFSDK_FormFillEnvironment* pFormFillEnv) + : m_pFormFillEnv(pFormFillEnv), + m_pInterForm(pdfium::MakeUnique( + m_pFormFillEnv->GetPDFDocument())) { + ASSERT(m_pFormFillEnv); + m_pInterForm->SetFormNotify(this); + RemoveAllHighLights(); +} + +CPDFSDK_InterForm::~CPDFSDK_InterForm() { + m_Map.clear(); +#ifdef PDF_ENABLE_XFA + m_XFAMap.clear(); +#endif // PDF_ENABLE_XFA +} + +CPDFSDK_Widget* CPDFSDK_InterForm::GetSibling(CPDFSDK_Widget* pWidget, + bool bNext) const { + auto pIterator = pdfium::MakeUnique( + pWidget->GetPageView(), CPDF_Annot::Subtype::WIDGET); + + return ToCPDFSDKWidget(bNext ? pIterator->GetNextAnnot(pWidget) + : pIterator->GetPrevAnnot(pWidget)); +} + +CPDFSDK_Widget* CPDFSDK_InterForm::GetWidget(CPDF_FormControl* pControl) const { + if (!pControl) + return nullptr; + + CPDFSDK_Widget* pWidget = nullptr; + const auto it = m_Map.find(pControl); + if (it != m_Map.end()) + pWidget = it->second; + if (pWidget) + return pWidget; + + CPDF_Dictionary* pControlDict = pControl->GetWidget(); + CPDF_Document* pDocument = m_pFormFillEnv->GetPDFDocument(); + CPDFSDK_PageView* pPage = nullptr; + + if (CPDF_Dictionary* pPageDict = pControlDict->GetDictFor("P")) { + int nPageIndex = pDocument->GetPageIndex(pPageDict->GetObjNum()); + if (nPageIndex >= 0) + pPage = m_pFormFillEnv->GetPageView(nPageIndex); + } + + if (!pPage) { + int nPageIndex = GetPageIndexByAnnotDict(pDocument, pControlDict); + if (nPageIndex >= 0) + pPage = m_pFormFillEnv->GetPageView(nPageIndex); + } + + return pPage ? ToCPDFSDKWidget(pPage->GetAnnotByDict(pControlDict)) : nullptr; +} + +void CPDFSDK_InterForm::GetWidgets( + const WideString& sFieldName, + std::vector* widgets) const { + for (int i = 0, sz = m_pInterForm->CountFields(sFieldName); i < sz; ++i) { + CPDF_FormField* pFormField = m_pInterForm->GetField(i, sFieldName); + ASSERT(pFormField); + GetWidgets(pFormField, widgets); + } +} + +void CPDFSDK_InterForm::GetWidgets( + CPDF_FormField* pField, + std::vector* widgets) const { + for (int i = 0, sz = pField->CountControls(); i < sz; ++i) { + CPDF_FormControl* pFormCtrl = pField->GetControl(i); + ASSERT(pFormCtrl); + CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl); + if (pWidget) + widgets->emplace_back(pWidget); + } +} + +int CPDFSDK_InterForm::GetPageIndexByAnnotDict( + CPDF_Document* pDocument, + CPDF_Dictionary* pAnnotDict) const { + ASSERT(pAnnotDict); + + for (int i = 0, sz = pDocument->GetPageCount(); i < sz; i++) { + if (CPDF_Dictionary* pPageDict = pDocument->GetPageDictionary(i)) { + if (CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots")) { + for (int j = 0, jsz = pAnnots->GetCount(); j < jsz; j++) { + CPDF_Object* pDict = pAnnots->GetDirectObjectAt(j); + if (pAnnotDict == pDict) + return i; + } + } + } + } + + return -1; +} + +void CPDFSDK_InterForm::AddMap(CPDF_FormControl* pControl, + CPDFSDK_Widget* pWidget) { + m_Map[pControl] = pWidget; +} + +void CPDFSDK_InterForm::RemoveMap(CPDF_FormControl* pControl) { + m_Map.erase(pControl); +} + +void CPDFSDK_InterForm::EnableCalculate(bool bEnabled) { + m_bCalculate = bEnabled; +} + +bool CPDFSDK_InterForm::IsCalculateEnabled() const { + return m_bCalculate; +} + +#ifdef PDF_ENABLE_XFA +void CPDFSDK_InterForm::AddXFAMap(CXFA_FFWidget* hWidget, + CPDFSDK_XFAWidget* pWidget) { + ASSERT(hWidget); + m_XFAMap[hWidget] = pWidget; +} + +void CPDFSDK_InterForm::RemoveXFAMap(CXFA_FFWidget* hWidget) { + ASSERT(hWidget); + m_XFAMap.erase(hWidget); +} + +CPDFSDK_XFAWidget* CPDFSDK_InterForm::GetXFAWidget(CXFA_FFWidget* hWidget) { + ASSERT(hWidget); + auto it = m_XFAMap.find(hWidget); + return it != m_XFAMap.end() ? it->second : nullptr; +} + +void CPDFSDK_InterForm::XfaEnableCalculate(bool bEnabled) { + m_bXfaCalculate = bEnabled; +} +bool CPDFSDK_InterForm::IsXfaCalculateEnabled() const { + return m_bXfaCalculate; +} + +bool CPDFSDK_InterForm::IsXfaValidationsEnabled() { + return m_bXfaValidationsEnabled; +} +void CPDFSDK_InterForm::XfaSetValidationsEnabled(bool bEnabled) { + m_bXfaValidationsEnabled = bEnabled; +} + +void CPDFSDK_InterForm::SynchronizeField(CPDF_FormField* pFormField) { + for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { + CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); + if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl)) + pWidget->Synchronize(false); + } +} +#endif // PDF_ENABLE_XFA + +void CPDFSDK_InterForm::OnCalculate(CPDF_FormField* pFormField) { + if (!m_pFormFillEnv->IsJSPlatformPresent()) + return; + + if (m_bBusy) + return; + + AutoRestorer restorer(&m_bBusy); + m_bBusy = true; + + if (!IsCalculateEnabled()) + return; + + IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime(); + int nSize = m_pInterForm->CountFieldsInCalculationOrder(); + for (int i = 0; i < nSize; i++) { + CPDF_FormField* pField = m_pInterForm->GetFieldInCalculationOrder(i); + if (!pField) + continue; + + FormFieldType fieldType = pField->GetFieldType(); + if (!IsFormFieldTypeComboOrText(fieldType)) + continue; + + CPDF_AAction aAction = pField->GetAdditionalAction(); + if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::Calculate)) + continue; + + CPDF_Action action = aAction.GetAction(CPDF_AAction::Calculate); + if (!action.GetDict()) + continue; + + WideString csJS = action.GetJavaScript(); + if (csJS.IsEmpty()) + continue; + + WideString sOldValue = pField->GetValue(); + WideString sValue = sOldValue; + bool bRC = true; + IJS_Runtime::ScopedEventContext pContext(pRuntime); + pContext->OnField_Calculate(pFormField, pField, &sValue, &bRC); + + Optional err = pContext->RunScript(csJS); + if (!err && bRC && sValue.Compare(sOldValue) != 0) + pField->SetValue(sValue, NotificationOption::kNotify); + } +} + +Optional CPDFSDK_InterForm::OnFormat(CPDF_FormField* pFormField) { + if (!m_pFormFillEnv->IsJSPlatformPresent()) + return {}; + + WideString sValue = pFormField->GetValue(); + IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime(); + if (pFormField->GetFieldType() == FormFieldType::kComboBox && + pFormField->CountSelectedItems() > 0) { + int index = pFormField->GetSelectedIndex(0); + if (index >= 0) + sValue = pFormField->GetOptionLabel(index); + } + + CPDF_AAction aAction = pFormField->GetAdditionalAction(); + if (aAction.GetDict() && aAction.ActionExist(CPDF_AAction::Format)) { + CPDF_Action action = aAction.GetAction(CPDF_AAction::Format); + if (action.GetDict()) { + WideString script = action.GetJavaScript(); + if (!script.IsEmpty()) { + IJS_Runtime::ScopedEventContext pContext(pRuntime); + pContext->OnField_Format(pFormField, &sValue, true); + Optional err = pContext->RunScript(script); + if (!err) + return sValue; + } + } + } + return {}; +} + +void CPDFSDK_InterForm::ResetFieldAppearance(CPDF_FormField* pFormField, + Optional sValue, + bool bValueChanged) { + for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { + CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); + ASSERT(pFormCtrl); + if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl)) + pWidget->ResetAppearance(sValue, bValueChanged); + } +} + +void CPDFSDK_InterForm::UpdateField(CPDF_FormField* pFormField) { + auto* formfiller = m_pFormFillEnv->GetInteractiveFormFiller(); + for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { + CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); + ASSERT(pFormCtrl); + + CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl); + if (!pWidget) + continue; + + IPDF_Page* pPage = pWidget->GetPage(); + FX_RECT rect = formfiller->GetViewBBox( + m_pFormFillEnv->GetPageView(pPage, false), pWidget); + m_pFormFillEnv->Invalidate(pPage, rect); + } +} + +bool CPDFSDK_InterForm::OnKeyStrokeCommit(CPDF_FormField* pFormField, + const WideString& csValue) { + CPDF_AAction aAction = pFormField->GetAdditionalAction(); + if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::KeyStroke)) + return true; + + CPDF_Action action = aAction.GetAction(CPDF_AAction::KeyStroke); + if (!action.GetDict()) + return true; + + CPDFSDK_FieldAction fa; + fa.bModifier = false; + fa.bShift = false; + fa.sValue = csValue; + m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript( + action, CPDF_AAction::KeyStroke, m_pFormFillEnv.Get(), pFormField, &fa); + return fa.bRC; +} + +bool CPDFSDK_InterForm::OnValidate(CPDF_FormField* pFormField, + const WideString& csValue) { + CPDF_AAction aAction = pFormField->GetAdditionalAction(); + if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::Validate)) + return true; + + CPDF_Action action = aAction.GetAction(CPDF_AAction::Validate); + if (!action.GetDict()) + return true; + + CPDFSDK_FieldAction fa; + fa.bModifier = false; + fa.bShift = false; + fa.sValue = csValue; + m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript( + action, CPDF_AAction::Validate, m_pFormFillEnv.Get(), pFormField, &fa); + return fa.bRC; +} + +bool CPDFSDK_InterForm::DoAction_Hide(const CPDF_Action& action) { + ASSERT(action.GetDict()); + + CPDF_ActionFields af(&action); + std::vector fieldObjects = af.GetAllFields(); + std::vector fields = GetFieldFromObjects(fieldObjects); + + bool bHide = action.GetHideStatus(); + bool bChanged = false; + + for (CPDF_FormField* pField : fields) { + for (int i = 0, sz = pField->CountControls(); i < sz; ++i) { + CPDF_FormControl* pControl = pField->GetControl(i); + ASSERT(pControl); + + if (CPDFSDK_Widget* pWidget = GetWidget(pControl)) { + uint32_t nFlags = pWidget->GetFlags(); + nFlags &= ~ANNOTFLAG_INVISIBLE; + nFlags &= ~ANNOTFLAG_NOVIEW; + if (bHide) + nFlags |= ANNOTFLAG_HIDDEN; + else + nFlags &= ~ANNOTFLAG_HIDDEN; + pWidget->SetFlags(nFlags); + pWidget->GetPageView()->UpdateView(pWidget); + bChanged = true; + } + } + } + + return bChanged; +} + +bool CPDFSDK_InterForm::DoAction_SubmitForm(const CPDF_Action& action) { + WideString sDestination = action.GetFilePath(); + if (sDestination.IsEmpty()) + return false; + + const CPDF_Dictionary* pActionDict = action.GetDict(); + if (pActionDict->KeyExist("Fields")) { + CPDF_ActionFields af(&action); + uint32_t dwFlags = action.GetFlags(); + std::vector fieldObjects = af.GetAllFields(); + std::vector fields = GetFieldFromObjects(fieldObjects); + if (!fields.empty()) { + bool bIncludeOrExclude = !(dwFlags & 0x01); + if (!m_pInterForm->CheckRequiredFields(&fields, bIncludeOrExclude)) + return false; + + return SubmitFields(sDestination, fields, bIncludeOrExclude, false); + } + } + if (!m_pInterForm->CheckRequiredFields(nullptr, true)) + return false; + + return SubmitForm(sDestination, false); +} + +bool CPDFSDK_InterForm::SubmitFields(const WideString& csDestination, + const std::vector& fields, + bool bIncludeOrExclude, + bool bUrlEncoded) { + ByteString textBuf = ExportFieldsToFDFTextBuf(fields, bIncludeOrExclude); + if (textBuf.IsEmpty()) + return false; + + std::vector buffer(textBuf.begin(), textBuf.end()); + if (bUrlEncoded && !FDFToURLEncodedData(&buffer)) + return false; + + m_pFormFillEnv->JS_docSubmitForm(buffer.data(), buffer.size(), csDestination); + return true; +} + +ByteString CPDFSDK_InterForm::ExportFieldsToFDFTextBuf( + const std::vector& fields, + bool bIncludeOrExclude) { + std::unique_ptr pFDF = m_pInterForm->ExportToFDF( + m_pFormFillEnv->JS_docGetFilePath(), fields, bIncludeOrExclude, false); + + return pFDF ? pFDF->WriteToString() : ByteString(); +} + +bool CPDFSDK_InterForm::SubmitForm(const WideString& sDestination, + bool bUrlEncoded) { + if (sDestination.IsEmpty()) + return false; + + std::unique_ptr pFDFDoc = + m_pInterForm->ExportToFDF(m_pFormFillEnv->JS_docGetFilePath(), false); + if (!pFDFDoc) + return false; + + ByteString fdfBuffer = pFDFDoc->WriteToString(); + if (fdfBuffer.IsEmpty()) + return false; + + std::vector buffer(fdfBuffer.begin(), fdfBuffer.end()); + if (bUrlEncoded && !FDFToURLEncodedData(&buffer)) + return false; + + m_pFormFillEnv->JS_docSubmitForm(buffer.data(), buffer.size(), sDestination); + return true; +} + +ByteString CPDFSDK_InterForm::ExportFormToFDFTextBuf() { + std::unique_ptr pFDF = + m_pInterForm->ExportToFDF(m_pFormFillEnv->JS_docGetFilePath(), false); + + return pFDF ? pFDF->WriteToString() : ByteString(); +} + +void CPDFSDK_InterForm::DoAction_ResetForm(const CPDF_Action& action) { + ASSERT(action.GetDict()); + const CPDF_Dictionary* pActionDict = action.GetDict(); + if (!pActionDict->KeyExist("Fields")) { + m_pInterForm->ResetForm(NotificationOption::kNotify); + return; + } + CPDF_ActionFields af(&action); + uint32_t dwFlags = action.GetFlags(); + std::vector fieldObjects = af.GetAllFields(); + std::vector fields = GetFieldFromObjects(fieldObjects); + m_pInterForm->ResetForm(fields, !(dwFlags & 0x01), + NotificationOption::kNotify); +} + +std::vector CPDFSDK_InterForm::GetFieldFromObjects( + const std::vector& objects) const { + std::vector fields; + for (const CPDF_Object* pObject : objects) { + if (!pObject || !pObject->IsString()) + continue; + + WideString csName = pObject->GetUnicodeText(); + CPDF_FormField* pField = m_pInterForm->GetField(0, csName); + if (pField) + fields.push_back(pField); + } + return fields; +} + +bool CPDFSDK_InterForm::BeforeValueChange(CPDF_FormField* pField, + const WideString& csValue) { + FormFieldType fieldType = pField->GetFieldType(); + if (!IsFormFieldTypeComboOrText(fieldType)) + return true; + if (!OnKeyStrokeCommit(pField, csValue)) + return false; + return OnValidate(pField, csValue); +} + +void CPDFSDK_InterForm::AfterValueChange(CPDF_FormField* pField) { +#ifdef PDF_ENABLE_XFA + SynchronizeField(pField); +#endif // PDF_ENABLE_XFA + + FormFieldType fieldType = pField->GetFieldType(); + if (!IsFormFieldTypeComboOrText(fieldType)) + return; + + OnCalculate(pField); + ResetFieldAppearance(pField, OnFormat(pField), true); + UpdateField(pField); +} + +bool CPDFSDK_InterForm::BeforeSelectionChange(CPDF_FormField* pField, + const WideString& csValue) { + if (pField->GetFieldType() != FormFieldType::kListBox) + return true; + if (!OnKeyStrokeCommit(pField, csValue)) + return false; + return OnValidate(pField, csValue); +} + +void CPDFSDK_InterForm::AfterSelectionChange(CPDF_FormField* pField) { + if (pField->GetFieldType() != FormFieldType::kListBox) + return; + + OnCalculate(pField); + ResetFieldAppearance(pField, pdfium::nullopt, true); + UpdateField(pField); +} + +void CPDFSDK_InterForm::AfterCheckedStatusChange(CPDF_FormField* pField) { + FormFieldType fieldType = pField->GetFieldType(); + if (fieldType != FormFieldType::kCheckBox && + fieldType != FormFieldType::kRadioButton) + return; + + OnCalculate(pField); + UpdateField(pField); +} + +void CPDFSDK_InterForm::AfterFormReset(CPDF_InterForm* pForm) { + OnCalculate(nullptr); +} + +bool CPDFSDK_InterForm::IsNeedHighLight(FormFieldType fieldType) const { + if (fieldType == FormFieldType::kUnknown) + return false; + +#ifdef PDF_ENABLE_XFA + // For the XFA fields, we need to return if the specific field type has + // highlight enabled or if the general XFA field type has it enabled. + if (IsFormFieldTypeXFA(fieldType)) { + if (!m_NeedsHighlight[static_cast(fieldType)]) + return m_NeedsHighlight[static_cast(FormFieldType::kXFA)]; + } +#endif // PDF_ENABLE_XFA + return m_NeedsHighlight[static_cast(fieldType)]; +} + +void CPDFSDK_InterForm::RemoveAllHighLights() { + std::fill(m_HighlightColor, m_HighlightColor + kFormFieldTypeCount, + kWhiteBGR); + std::fill(m_NeedsHighlight, m_NeedsHighlight + kFormFieldTypeCount, false); +} + +void CPDFSDK_InterForm::SetHighlightColor(FX_COLORREF clr, + FormFieldType fieldType) { + if (fieldType == FormFieldType::kUnknown) + return; + + m_HighlightColor[static_cast(fieldType)] = clr; + m_NeedsHighlight[static_cast(fieldType)] = true; +} + +void CPDFSDK_InterForm::SetAllHighlightColors(FX_COLORREF clr) { + for (auto type : kFormFieldTypes) { + m_HighlightColor[static_cast(type)] = clr; + m_NeedsHighlight[static_cast(type)] = true; + } +} + +FX_COLORREF CPDFSDK_InterForm::GetHighlightColor(FormFieldType fieldType) { + if (fieldType == FormFieldType::kUnknown) + return kWhiteBGR; + +#ifdef PDF_ENABLE_XFA + // For the XFA fields, we need to return the specific field type highlight + // colour or the general XFA field type colour if present. + if (IsFormFieldTypeXFA(fieldType)) { + if (!m_NeedsHighlight[static_cast(fieldType)] && + m_NeedsHighlight[static_cast(FormFieldType::kXFA)]) { + return m_HighlightColor[static_cast(FormFieldType::kXFA)]; + } + } +#endif // PDF_ENABLE_XFA + return m_HighlightColor[static_cast(fieldType)]; +} diff --git a/fpdfsdk/cpdfsdk_interactiveform.h b/fpdfsdk/cpdfsdk_interactiveform.h new file mode 100644 index 0000000000..06492e52a2 --- /dev/null +++ b/fpdfsdk/cpdfsdk_interactiveform.h @@ -0,0 +1,132 @@ +// Copyright 2016 PDFium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com + +#ifndef FPDFSDK_CPDFSDK_INTERACTIVEFORM_H_ +#define FPDFSDK_CPDFSDK_INTERACTIVEFORM_H_ + +#include +#include +#include + +#include "core/fpdfdoc/cpdf_action.h" +#include "core/fpdfdoc/ipdf_formnotify.h" +#include "core/fxcrt/unowned_ptr.h" +#include "core/fxge/fx_dib.h" +#include "fpdfsdk/cpdfsdk_widget.h" +#include "third_party/base/optional.h" + +class CPDF_Dictionary; +class CPDF_FormControl; +class CPDF_FormField; +class CPDF_InterForm; +class CPDF_Object; +class CPDFSDK_FormFillEnvironment; + +#ifdef PDF_ENABLE_XFA +class CPDFSDK_XFAWidget; +class CXFA_FFWidget; +#endif // PDF_ENABLE_XFA + +class CPDFSDK_InterForm final : public IPDF_FormNotify { + public: + explicit CPDFSDK_InterForm(CPDFSDK_FormFillEnvironment* pFormFillEnv); + ~CPDFSDK_InterForm() override; + + CPDF_InterForm* GetInterForm() const { return m_pInterForm.get(); } + CPDFSDK_FormFillEnvironment* GetFormFillEnv() const { + return m_pFormFillEnv.Get(); + } + + CPDFSDK_Widget* GetSibling(CPDFSDK_Widget* pWidget, bool bNext) const; + CPDFSDK_Widget* GetWidget(CPDF_FormControl* pControl) const; + void GetWidgets(const WideString& sFieldName, + std::vector* widgets) const; + void GetWidgets(CPDF_FormField* pField, + std::vector* widgets) const; + + void AddMap(CPDF_FormControl* pControl, CPDFSDK_Widget* pWidget); + void RemoveMap(CPDF_FormControl* pControl); + + void EnableCalculate(bool bEnabled); + bool IsCalculateEnabled() const; + +#ifdef PDF_ENABLE_XFA + void AddXFAMap(CXFA_FFWidget* hWidget, CPDFSDK_XFAWidget* pWidget); + void RemoveXFAMap(CXFA_FFWidget* hWidget); + CPDFSDK_XFAWidget* GetXFAWidget(CXFA_FFWidget* hWidget); + void XfaEnableCalculate(bool bEnabled); + bool IsXfaCalculateEnabled() const; + bool IsXfaValidationsEnabled(); + void XfaSetValidationsEnabled(bool bEnabled); + void SynchronizeField(CPDF_FormField* pFormField); +#endif // PDF_ENABLE_XFA + + bool OnKeyStrokeCommit(CPDF_FormField* pFormField, const WideString& csValue); + bool OnValidate(CPDF_FormField* pFormField, const WideString& csValue); + void OnCalculate(CPDF_FormField* pFormField); + Optional OnFormat(CPDF_FormField* pFormField); + + void ResetFieldAppearance(CPDF_FormField* pFormField, + Optional sValue, + bool bValueChanged); + void UpdateField(CPDF_FormField* pFormField); + + bool DoAction_Hide(const CPDF_Action& action); + bool DoAction_SubmitForm(const CPDF_Action& action); + void DoAction_ResetForm(const CPDF_Action& action); + + std::vector GetFieldFromObjects( + const std::vector& objects) const; + bool IsValidField(CPDF_Dictionary* pFieldDict); + bool SubmitFields(const WideString& csDestination, + const std::vector& fields, + bool bIncludeOrExclude, + bool bUrlEncoded); + bool SubmitForm(const WideString& sDestination, bool bUrlEncoded); + ByteString ExportFormToFDFTextBuf(); + ByteString ExportFieldsToFDFTextBuf( + const std::vector& fields, + bool bIncludeOrExclude); + + bool IsNeedHighLight(FormFieldType fieldType) const; + void RemoveAllHighLights(); + void SetHighlightAlpha(uint8_t alpha) { m_HighlightAlpha = alpha; } + uint8_t GetHighlightAlpha() { return m_HighlightAlpha; } + void SetHighlightColor(FX_COLORREF clr, FormFieldType fieldType); + void SetAllHighlightColors(FX_COLORREF clr); + FX_COLORREF GetHighlightColor(FormFieldType fieldType); + + private: + // IPDF_FormNotify: + bool BeforeValueChange(CPDF_FormField* pField, + const WideString& csValue) override; + void AfterValueChange(CPDF_FormField* pField) override; + bool BeforeSelectionChange(CPDF_FormField* pField, + const WideString& csValue) override; + void AfterSelectionChange(CPDF_FormField* pField) override; + void AfterCheckedStatusChange(CPDF_FormField* pField) override; + void AfterFormReset(CPDF_InterForm* pForm) override; + + int GetPageIndexByAnnotDict(CPDF_Document* pDocument, + CPDF_Dictionary* pAnnotDict) const; + + UnownedPtr const m_pFormFillEnv; + std::unique_ptr const m_pInterForm; + std::map m_Map; +#ifdef PDF_ENABLE_XFA + std::map m_XFAMap; + bool m_bXfaCalculate = true; + bool m_bXfaValidationsEnabled = true; +#endif // PDF_ENABLE_XFA + bool m_bCalculate = true; + bool m_bBusy = false; + + uint8_t m_HighlightAlpha = 0; + FX_COLORREF m_HighlightColor[kFormFieldTypeCount]; + bool m_NeedsHighlight[kFormFieldTypeCount]; +}; + +#endif // FPDFSDK_CPDFSDK_INTERACTIVEFORM_H_ diff --git a/fpdfsdk/cpdfsdk_interform.cpp b/fpdfsdk/cpdfsdk_interform.cpp deleted file mode 100644 index 66a52b6dee..0000000000 --- a/fpdfsdk/cpdfsdk_interform.cpp +++ /dev/null @@ -1,672 +0,0 @@ -// Copyright 2016 PDFium Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com - -#include "fpdfsdk/cpdfsdk_interform.h" - -#include -#include -#include -#include -#include -#include - -#include "core/fpdfapi/page/cpdf_page.h" -#include "core/fpdfapi/parser/cfdf_document.h" -#include "core/fpdfapi/parser/cpdf_array.h" -#include "core/fpdfapi/parser/cpdf_dictionary.h" -#include "core/fpdfapi/parser/cpdf_document.h" -#include "core/fpdfapi/parser/cpdf_stream.h" -#include "core/fpdfdoc/cpdf_actionfields.h" -#include "core/fpdfdoc/cpdf_interform.h" -#include "core/fxcrt/autorestorer.h" -#include "core/fxge/cfx_graphstatedata.h" -#include "core/fxge/cfx_pathdata.h" -#include "fpdfsdk/cpdfsdk_actionhandler.h" -#include "fpdfsdk/cpdfsdk_annot.h" -#include "fpdfsdk/cpdfsdk_annotiterator.h" -#include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_helpers.h" -#include "fpdfsdk/cpdfsdk_pageview.h" -#include "fpdfsdk/cpdfsdk_widget.h" -#include "fpdfsdk/formfiller/cffl_formfiller.h" -#include "fpdfsdk/ipdfsdk_annothandler.h" -#include "fxjs/ijs_event_context.h" -#include "fxjs/ijs_runtime.h" -#include "third_party/base/ptr_util.h" -#include "third_party/base/stl_util.h" - -#ifdef PDF_ENABLE_XFA -#include "fpdfsdk/cpdfsdk_xfawidget.h" -#include "fpdfsdk/fpdfxfa/cpdfxfa_context.h" -#include "fpdfsdk/fpdfxfa/cxfa_fwladaptertimermgr.h" -#include "xfa/fxfa/cxfa_eventparam.h" -#include "xfa/fxfa/cxfa_ffdocview.h" -#include "xfa/fxfa/cxfa_ffwidget.h" -#include "xfa/fxfa/cxfa_ffwidgethandler.h" -#endif // PDF_ENABLE_XFA - -namespace { - -constexpr uint32_t kWhiteBGR = FXSYS_BGR(255, 255, 255); - -bool IsFormFieldTypeComboOrText(FormFieldType fieldType) { - switch (fieldType) { - case FormFieldType::kComboBox: - case FormFieldType::kTextField: - return true; - default: - return false; - } -} - -#ifdef PDF_ENABLE_XFA -bool IsFormFieldTypeXFA(FormFieldType fieldType) { - switch (fieldType) { - case FormFieldType::kXFA: - case FormFieldType::kXFA_CheckBox: - case FormFieldType::kXFA_ComboBox: - case FormFieldType::kXFA_ImageField: - case FormFieldType::kXFA_ListBox: - case FormFieldType::kXFA_PushButton: - case FormFieldType::kXFA_Signature: - case FormFieldType::kXFA_TextField: - return true; - default: - return false; - } -} -#endif // PDF_ENABLE_XFA - -bool FDFToURLEncodedData(std::vector* pBuffer) { - std::unique_ptr pFDF = CFDF_Document::ParseMemory(*pBuffer); - if (!pFDF) - return true; - - CPDF_Dictionary* pMainDict = pFDF->GetRoot()->GetDictFor("FDF"); - if (!pMainDict) - return false; - - CPDF_Array* pFields = pMainDict->GetArrayFor("Fields"); - if (!pFields) - return false; - - std::ostringstream fdfEncodedData; - for (uint32_t i = 0; i < pFields->GetCount(); i++) { - CPDF_Dictionary* pField = pFields->GetDictAt(i); - if (!pField) - continue; - WideString name; - name = pField->GetUnicodeTextFor("T"); - ByteString name_b = name.ToDefANSI(); - ByteString csBValue = pField->GetStringFor("V"); - WideString csWValue = PDF_DecodeText(csBValue); - ByteString csValue_b = csWValue.ToDefANSI(); - fdfEncodedData << name_b << "=" << csValue_b; - if (i != pFields->GetCount() - 1) - fdfEncodedData << "&"; - } - - size_t nBufSize = fdfEncodedData.tellp(); - if (nBufSize <= 0) - return false; - - pBuffer->resize(nBufSize); - memcpy(pBuffer->data(), fdfEncodedData.str().c_str(), nBufSize); - return true; -} - -} // namespace - -CPDFSDK_InterForm::CPDFSDK_InterForm(CPDFSDK_FormFillEnvironment* pFormFillEnv) - : m_pFormFillEnv(pFormFillEnv), - m_pInterForm(pdfium::MakeUnique( - m_pFormFillEnv->GetPDFDocument())) { - ASSERT(m_pFormFillEnv); - m_pInterForm->SetFormNotify(this); - RemoveAllHighLights(); -} - -CPDFSDK_InterForm::~CPDFSDK_InterForm() { - m_Map.clear(); -#ifdef PDF_ENABLE_XFA - m_XFAMap.clear(); -#endif // PDF_ENABLE_XFA -} - -CPDFSDK_Widget* CPDFSDK_InterForm::GetSibling(CPDFSDK_Widget* pWidget, - bool bNext) const { - auto pIterator = pdfium::MakeUnique( - pWidget->GetPageView(), CPDF_Annot::Subtype::WIDGET); - - return ToCPDFSDKWidget(bNext ? pIterator->GetNextAnnot(pWidget) - : pIterator->GetPrevAnnot(pWidget)); -} - -CPDFSDK_Widget* CPDFSDK_InterForm::GetWidget(CPDF_FormControl* pControl) const { - if (!pControl) - return nullptr; - - CPDFSDK_Widget* pWidget = nullptr; - const auto it = m_Map.find(pControl); - if (it != m_Map.end()) - pWidget = it->second; - if (pWidget) - return pWidget; - - CPDF_Dictionary* pControlDict = pControl->GetWidget(); - CPDF_Document* pDocument = m_pFormFillEnv->GetPDFDocument(); - CPDFSDK_PageView* pPage = nullptr; - - if (CPDF_Dictionary* pPageDict = pControlDict->GetDictFor("P")) { - int nPageIndex = pDocument->GetPageIndex(pPageDict->GetObjNum()); - if (nPageIndex >= 0) - pPage = m_pFormFillEnv->GetPageView(nPageIndex); - } - - if (!pPage) { - int nPageIndex = GetPageIndexByAnnotDict(pDocument, pControlDict); - if (nPageIndex >= 0) - pPage = m_pFormFillEnv->GetPageView(nPageIndex); - } - - return pPage ? ToCPDFSDKWidget(pPage->GetAnnotByDict(pControlDict)) : nullptr; -} - -void CPDFSDK_InterForm::GetWidgets( - const WideString& sFieldName, - std::vector* widgets) const { - for (int i = 0, sz = m_pInterForm->CountFields(sFieldName); i < sz; ++i) { - CPDF_FormField* pFormField = m_pInterForm->GetField(i, sFieldName); - ASSERT(pFormField); - GetWidgets(pFormField, widgets); - } -} - -void CPDFSDK_InterForm::GetWidgets( - CPDF_FormField* pField, - std::vector* widgets) const { - for (int i = 0, sz = pField->CountControls(); i < sz; ++i) { - CPDF_FormControl* pFormCtrl = pField->GetControl(i); - ASSERT(pFormCtrl); - CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl); - if (pWidget) - widgets->emplace_back(pWidget); - } -} - -int CPDFSDK_InterForm::GetPageIndexByAnnotDict( - CPDF_Document* pDocument, - CPDF_Dictionary* pAnnotDict) const { - ASSERT(pAnnotDict); - - for (int i = 0, sz = pDocument->GetPageCount(); i < sz; i++) { - if (CPDF_Dictionary* pPageDict = pDocument->GetPageDictionary(i)) { - if (CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots")) { - for (int j = 0, jsz = pAnnots->GetCount(); j < jsz; j++) { - CPDF_Object* pDict = pAnnots->GetDirectObjectAt(j); - if (pAnnotDict == pDict) - return i; - } - } - } - } - - return -1; -} - -void CPDFSDK_InterForm::AddMap(CPDF_FormControl* pControl, - CPDFSDK_Widget* pWidget) { - m_Map[pControl] = pWidget; -} - -void CPDFSDK_InterForm::RemoveMap(CPDF_FormControl* pControl) { - m_Map.erase(pControl); -} - -void CPDFSDK_InterForm::EnableCalculate(bool bEnabled) { - m_bCalculate = bEnabled; -} - -bool CPDFSDK_InterForm::IsCalculateEnabled() const { - return m_bCalculate; -} - -#ifdef PDF_ENABLE_XFA -void CPDFSDK_InterForm::AddXFAMap(CXFA_FFWidget* hWidget, - CPDFSDK_XFAWidget* pWidget) { - ASSERT(hWidget); - m_XFAMap[hWidget] = pWidget; -} - -void CPDFSDK_InterForm::RemoveXFAMap(CXFA_FFWidget* hWidget) { - ASSERT(hWidget); - m_XFAMap.erase(hWidget); -} - -CPDFSDK_XFAWidget* CPDFSDK_InterForm::GetXFAWidget(CXFA_FFWidget* hWidget) { - ASSERT(hWidget); - auto it = m_XFAMap.find(hWidget); - return it != m_XFAMap.end() ? it->second : nullptr; -} - -void CPDFSDK_InterForm::XfaEnableCalculate(bool bEnabled) { - m_bXfaCalculate = bEnabled; -} -bool CPDFSDK_InterForm::IsXfaCalculateEnabled() const { - return m_bXfaCalculate; -} - -bool CPDFSDK_InterForm::IsXfaValidationsEnabled() { - return m_bXfaValidationsEnabled; -} -void CPDFSDK_InterForm::XfaSetValidationsEnabled(bool bEnabled) { - m_bXfaValidationsEnabled = bEnabled; -} - -void CPDFSDK_InterForm::SynchronizeField(CPDF_FormField* pFormField) { - for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { - CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); - if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl)) - pWidget->Synchronize(false); - } -} -#endif // PDF_ENABLE_XFA - -void CPDFSDK_InterForm::OnCalculate(CPDF_FormField* pFormField) { - if (!m_pFormFillEnv->IsJSPlatformPresent()) - return; - - if (m_bBusy) - return; - - AutoRestorer restorer(&m_bBusy); - m_bBusy = true; - - if (!IsCalculateEnabled()) - return; - - IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime(); - int nSize = m_pInterForm->CountFieldsInCalculationOrder(); - for (int i = 0; i < nSize; i++) { - CPDF_FormField* pField = m_pInterForm->GetFieldInCalculationOrder(i); - if (!pField) - continue; - - FormFieldType fieldType = pField->GetFieldType(); - if (!IsFormFieldTypeComboOrText(fieldType)) - continue; - - CPDF_AAction aAction = pField->GetAdditionalAction(); - if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::Calculate)) - continue; - - CPDF_Action action = aAction.GetAction(CPDF_AAction::Calculate); - if (!action.GetDict()) - continue; - - WideString csJS = action.GetJavaScript(); - if (csJS.IsEmpty()) - continue; - - WideString sOldValue = pField->GetValue(); - WideString sValue = sOldValue; - bool bRC = true; - IJS_Runtime::ScopedEventContext pContext(pRuntime); - pContext->OnField_Calculate(pFormField, pField, &sValue, &bRC); - - Optional err = pContext->RunScript(csJS); - if (!err && bRC && sValue.Compare(sOldValue) != 0) - pField->SetValue(sValue, NotificationOption::kNotify); - } -} - -Optional CPDFSDK_InterForm::OnFormat(CPDF_FormField* pFormField) { - if (!m_pFormFillEnv->IsJSPlatformPresent()) - return {}; - - WideString sValue = pFormField->GetValue(); - IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime(); - if (pFormField->GetFieldType() == FormFieldType::kComboBox && - pFormField->CountSelectedItems() > 0) { - int index = pFormField->GetSelectedIndex(0); - if (index >= 0) - sValue = pFormField->GetOptionLabel(index); - } - - CPDF_AAction aAction = pFormField->GetAdditionalAction(); - if (aAction.GetDict() && aAction.ActionExist(CPDF_AAction::Format)) { - CPDF_Action action = aAction.GetAction(CPDF_AAction::Format); - if (action.GetDict()) { - WideString script = action.GetJavaScript(); - if (!script.IsEmpty()) { - IJS_Runtime::ScopedEventContext pContext(pRuntime); - pContext->OnField_Format(pFormField, &sValue, true); - Optional err = pContext->RunScript(script); - if (!err) - return sValue; - } - } - } - return {}; -} - -void CPDFSDK_InterForm::ResetFieldAppearance(CPDF_FormField* pFormField, - Optional sValue, - bool bValueChanged) { - for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { - CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); - ASSERT(pFormCtrl); - if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl)) - pWidget->ResetAppearance(sValue, bValueChanged); - } -} - -void CPDFSDK_InterForm::UpdateField(CPDF_FormField* pFormField) { - auto* formfiller = m_pFormFillEnv->GetInteractiveFormFiller(); - for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) { - CPDF_FormControl* pFormCtrl = pFormField->GetControl(i); - ASSERT(pFormCtrl); - - CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl); - if (!pWidget) - continue; - - IPDF_Page* pPage = pWidget->GetPage(); - FX_RECT rect = formfiller->GetViewBBox( - m_pFormFillEnv->GetPageView(pPage, false), pWidget); - m_pFormFillEnv->Invalidate(pPage, rect); - } -} - -bool CPDFSDK_InterForm::OnKeyStrokeCommit(CPDF_FormField* pFormField, - const WideString& csValue) { - CPDF_AAction aAction = pFormField->GetAdditionalAction(); - if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::KeyStroke)) - return true; - - CPDF_Action action = aAction.GetAction(CPDF_AAction::KeyStroke); - if (!action.GetDict()) - return true; - - CPDFSDK_FieldAction fa; - fa.bModifier = false; - fa.bShift = false; - fa.sValue = csValue; - m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript( - action, CPDF_AAction::KeyStroke, m_pFormFillEnv.Get(), pFormField, &fa); - return fa.bRC; -} - -bool CPDFSDK_InterForm::OnValidate(CPDF_FormField* pFormField, - const WideString& csValue) { - CPDF_AAction aAction = pFormField->GetAdditionalAction(); - if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::Validate)) - return true; - - CPDF_Action action = aAction.GetAction(CPDF_AAction::Validate); - if (!action.GetDict()) - return true; - - CPDFSDK_FieldAction fa; - fa.bModifier = false; - fa.bShift = false; - fa.sValue = csValue; - m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript( - action, CPDF_AAction::Validate, m_pFormFillEnv.Get(), pFormField, &fa); - return fa.bRC; -} - -bool CPDFSDK_InterForm::DoAction_Hide(const CPDF_Action& action) { - ASSERT(action.GetDict()); - - CPDF_ActionFields af(&action); - std::vector fieldObjects = af.GetAllFields(); - std::vector fields = GetFieldFromObjects(fieldObjects); - - bool bHide = action.GetHideStatus(); - bool bChanged = false; - - for (CPDF_FormField* pField : fields) { - for (int i = 0, sz = pField->CountControls(); i < sz; ++i) { - CPDF_FormControl* pControl = pField->GetControl(i); - ASSERT(pControl); - - if (CPDFSDK_Widget* pWidget = GetWidget(pControl)) { - uint32_t nFlags = pWidget->GetFlags(); - nFlags &= ~ANNOTFLAG_INVISIBLE; - nFlags &= ~ANNOTFLAG_NOVIEW; - if (bHide) - nFlags |= ANNOTFLAG_HIDDEN; - else - nFlags &= ~ANNOTFLAG_HIDDEN; - pWidget->SetFlags(nFlags); - pWidget->GetPageView()->UpdateView(pWidget); - bChanged = true; - } - } - } - - return bChanged; -} - -bool CPDFSDK_InterForm::DoAction_SubmitForm(const CPDF_Action& action) { - WideString sDestination = action.GetFilePath(); - if (sDestination.IsEmpty()) - return false; - - const CPDF_Dictionary* pActionDict = action.GetDict(); - if (pActionDict->KeyExist("Fields")) { - CPDF_ActionFields af(&action); - uint32_t dwFlags = action.GetFlags(); - std::vector fieldObjects = af.GetAllFields(); - std::vector fields = GetFieldFromObjects(fieldObjects); - if (!fields.empty()) { - bool bIncludeOrExclude = !(dwFlags & 0x01); - if (!m_pInterForm->CheckRequiredFields(&fields, bIncludeOrExclude)) - return false; - - return SubmitFields(sDestination, fields, bIncludeOrExclude, false); - } - } - if (!m_pInterForm->CheckRequiredFields(nullptr, true)) - return false; - - return SubmitForm(sDestination, false); -} - -bool CPDFSDK_InterForm::SubmitFields(const WideString& csDestination, - const std::vector& fields, - bool bIncludeOrExclude, - bool bUrlEncoded) { - ByteString textBuf = ExportFieldsToFDFTextBuf(fields, bIncludeOrExclude); - if (textBuf.IsEmpty()) - return false; - - std::vector buffer(textBuf.begin(), textBuf.end()); - if (bUrlEncoded && !FDFToURLEncodedData(&buffer)) - return false; - - m_pFormFillEnv->JS_docSubmitForm(buffer.data(), buffer.size(), csDestination); - return true; -} - -ByteString CPDFSDK_InterForm::ExportFieldsToFDFTextBuf( - const std::vector& fields, - bool bIncludeOrExclude) { - std::unique_ptr pFDF = m_pInterForm->ExportToFDF( - m_pFormFillEnv->JS_docGetFilePath(), fields, bIncludeOrExclude, false); - - return pFDF ? pFDF->WriteToString() : ByteString(); -} - -bool CPDFSDK_InterForm::SubmitForm(const WideString& sDestination, - bool bUrlEncoded) { - if (sDestination.IsEmpty()) - return false; - - std::unique_ptr pFDFDoc = - m_pInterForm->ExportToFDF(m_pFormFillEnv->JS_docGetFilePath(), false); - if (!pFDFDoc) - return false; - - ByteString fdfBuffer = pFDFDoc->WriteToString(); - if (fdfBuffer.IsEmpty()) - return false; - - std::vector buffer(fdfBuffer.begin(), fdfBuffer.end()); - if (bUrlEncoded && !FDFToURLEncodedData(&buffer)) - return false; - - m_pFormFillEnv->JS_docSubmitForm(buffer.data(), buffer.size(), sDestination); - return true; -} - -ByteString CPDFSDK_InterForm::ExportFormToFDFTextBuf() { - std::unique_ptr pFDF = - m_pInterForm->ExportToFDF(m_pFormFillEnv->JS_docGetFilePath(), false); - - return pFDF ? pFDF->WriteToString() : ByteString(); -} - -void CPDFSDK_InterForm::DoAction_ResetForm(const CPDF_Action& action) { - ASSERT(action.GetDict()); - const CPDF_Dictionary* pActionDict = action.GetDict(); - if (!pActionDict->KeyExist("Fields")) { - m_pInterForm->ResetForm(NotificationOption::kNotify); - return; - } - CPDF_ActionFields af(&action); - uint32_t dwFlags = action.GetFlags(); - std::vector fieldObjects = af.GetAllFields(); - std::vector fields = GetFieldFromObjects(fieldObjects); - m_pInterForm->ResetForm(fields, !(dwFlags & 0x01), - NotificationOption::kNotify); -} - -std::vector CPDFSDK_InterForm::GetFieldFromObjects( - const std::vector& objects) const { - std::vector fields; - for (const CPDF_Object* pObject : objects) { - if (!pObject || !pObject->IsString()) - continue; - - WideString csName = pObject->GetUnicodeText(); - CPDF_FormField* pField = m_pInterForm->GetField(0, csName); - if (pField) - fields.push_back(pField); - } - return fields; -} - -bool CPDFSDK_InterForm::BeforeValueChange(CPDF_FormField* pField, - const WideString& csValue) { - FormFieldType fieldType = pField->GetFieldType(); - if (!IsFormFieldTypeComboOrText(fieldType)) - return true; - if (!OnKeyStrokeCommit(pField, csValue)) - return false; - return OnValidate(pField, csValue); -} - -void CPDFSDK_InterForm::AfterValueChange(CPDF_FormField* pField) { -#ifdef PDF_ENABLE_XFA - SynchronizeField(pField); -#endif // PDF_ENABLE_XFA - - FormFieldType fieldType = pField->GetFieldType(); - if (!IsFormFieldTypeComboOrText(fieldType)) - return; - - OnCalculate(pField); - ResetFieldAppearance(pField, OnFormat(pField), true); - UpdateField(pField); -} - -bool CPDFSDK_InterForm::BeforeSelectionChange(CPDF_FormField* pField, - const WideString& csValue) { - if (pField->GetFieldType() != FormFieldType::kListBox) - return true; - if (!OnKeyStrokeCommit(pField, csValue)) - return false; - return OnValidate(pField, csValue); -} - -void CPDFSDK_InterForm::AfterSelectionChange(CPDF_FormField* pField) { - if (pField->GetFieldType() != FormFieldType::kListBox) - return; - - OnCalculate(pField); - ResetFieldAppearance(pField, pdfium::nullopt, true); - UpdateField(pField); -} - -void CPDFSDK_InterForm::AfterCheckedStatusChange(CPDF_FormField* pField) { - FormFieldType fieldType = pField->GetFieldType(); - if (fieldType != FormFieldType::kCheckBox && - fieldType != FormFieldType::kRadioButton) - return; - - OnCalculate(pField); - UpdateField(pField); -} - -void CPDFSDK_InterForm::AfterFormReset(CPDF_InterForm* pForm) { - OnCalculate(nullptr); -} - -bool CPDFSDK_InterForm::IsNeedHighLight(FormFieldType fieldType) const { - if (fieldType == FormFieldType::kUnknown) - return false; - -#ifdef PDF_ENABLE_XFA - // For the XFA fields, we need to return if the specific field type has - // highlight enabled or if the general XFA field type has it enabled. - if (IsFormFieldTypeXFA(fieldType)) { - if (!m_NeedsHighlight[static_cast(fieldType)]) - return m_NeedsHighlight[static_cast(FormFieldType::kXFA)]; - } -#endif // PDF_ENABLE_XFA - return m_NeedsHighlight[static_cast(fieldType)]; -} - -void CPDFSDK_InterForm::RemoveAllHighLights() { - std::fill(m_HighlightColor, m_HighlightColor + kFormFieldTypeCount, - kWhiteBGR); - std::fill(m_NeedsHighlight, m_NeedsHighlight + kFormFieldTypeCount, false); -} - -void CPDFSDK_InterForm::SetHighlightColor(FX_COLORREF clr, - FormFieldType fieldType) { - if (fieldType == FormFieldType::kUnknown) - return; - - m_HighlightColor[static_cast(fieldType)] = clr; - m_NeedsHighlight[static_cast(fieldType)] = true; -} - -void CPDFSDK_InterForm::SetAllHighlightColors(FX_COLORREF clr) { - for (auto type : kFormFieldTypes) { - m_HighlightColor[static_cast(type)] = clr; - m_NeedsHighlight[static_cast(type)] = true; - } -} - -FX_COLORREF CPDFSDK_InterForm::GetHighlightColor(FormFieldType fieldType) { - if (fieldType == FormFieldType::kUnknown) - return kWhiteBGR; - -#ifdef PDF_ENABLE_XFA - // For the XFA fields, we need to return the specific field type highlight - // colour or the general XFA field type colour if present. - if (IsFormFieldTypeXFA(fieldType)) { - if (!m_NeedsHighlight[static_cast(fieldType)] && - m_NeedsHighlight[static_cast(FormFieldType::kXFA)]) { - return m_HighlightColor[static_cast(FormFieldType::kXFA)]; - } - } -#endif // PDF_ENABLE_XFA - return m_HighlightColor[static_cast(fieldType)]; -} diff --git a/fpdfsdk/cpdfsdk_interform.h b/fpdfsdk/cpdfsdk_interform.h deleted file mode 100644 index 2a34c23748..0000000000 --- a/fpdfsdk/cpdfsdk_interform.h +++ /dev/null @@ -1,132 +0,0 @@ -// Copyright 2016 PDFium Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com - -#ifndef FPDFSDK_CPDFSDK_INTERFORM_H_ -#define FPDFSDK_CPDFSDK_INTERFORM_H_ - -#include -#include -#include - -#include "core/fpdfdoc/cpdf_action.h" -#include "core/fpdfdoc/ipdf_formnotify.h" -#include "core/fxcrt/unowned_ptr.h" -#include "core/fxge/fx_dib.h" -#include "fpdfsdk/cpdfsdk_widget.h" -#include "third_party/base/optional.h" - -class CPDF_Dictionary; -class CPDF_FormControl; -class CPDF_FormField; -class CPDF_InterForm; -class CPDF_Object; -class CPDFSDK_FormFillEnvironment; - -#ifdef PDF_ENABLE_XFA -class CPDFSDK_XFAWidget; -class CXFA_FFWidget; -#endif // PDF_ENABLE_XFA - -class CPDFSDK_InterForm final : public IPDF_FormNotify { - public: - explicit CPDFSDK_InterForm(CPDFSDK_FormFillEnvironment* pFormFillEnv); - ~CPDFSDK_InterForm() override; - - CPDF_InterForm* GetInterForm() const { return m_pInterForm.get(); } - CPDFSDK_FormFillEnvironment* GetFormFillEnv() const { - return m_pFormFillEnv.Get(); - } - - CPDFSDK_Widget* GetSibling(CPDFSDK_Widget* pWidget, bool bNext) const; - CPDFSDK_Widget* GetWidget(CPDF_FormControl* pControl) const; - void GetWidgets(const WideString& sFieldName, - std::vector* widgets) const; - void GetWidgets(CPDF_FormField* pField, - std::vector* widgets) const; - - void AddMap(CPDF_FormControl* pControl, CPDFSDK_Widget* pWidget); - void RemoveMap(CPDF_FormControl* pControl); - - void EnableCalculate(bool bEnabled); - bool IsCalculateEnabled() const; - -#ifdef PDF_ENABLE_XFA - void AddXFAMap(CXFA_FFWidget* hWidget, CPDFSDK_XFAWidget* pWidget); - void RemoveXFAMap(CXFA_FFWidget* hWidget); - CPDFSDK_XFAWidget* GetXFAWidget(CXFA_FFWidget* hWidget); - void XfaEnableCalculate(bool bEnabled); - bool IsXfaCalculateEnabled() const; - bool IsXfaValidationsEnabled(); - void XfaSetValidationsEnabled(bool bEnabled); - void SynchronizeField(CPDF_FormField* pFormField); -#endif // PDF_ENABLE_XFA - - bool OnKeyStrokeCommit(CPDF_FormField* pFormField, const WideString& csValue); - bool OnValidate(CPDF_FormField* pFormField, const WideString& csValue); - void OnCalculate(CPDF_FormField* pFormField); - Optional OnFormat(CPDF_FormField* pFormField); - - void ResetFieldAppearance(CPDF_FormField* pFormField, - Optional sValue, - bool bValueChanged); - void UpdateField(CPDF_FormField* pFormField); - - bool DoAction_Hide(const CPDF_Action& action); - bool DoAction_SubmitForm(const CPDF_Action& action); - void DoAction_ResetForm(const CPDF_Action& action); - - std::vector GetFieldFromObjects( - const std::vector& objects) const; - bool IsValidField(CPDF_Dictionary* pFieldDict); - bool SubmitFields(const WideString& csDestination, - const std::vector& fields, - bool bIncludeOrExclude, - bool bUrlEncoded); - bool SubmitForm(const WideString& sDestination, bool bUrlEncoded); - ByteString ExportFormToFDFTextBuf(); - ByteString ExportFieldsToFDFTextBuf( - const std::vector& fields, - bool bIncludeOrExclude); - - bool IsNeedHighLight(FormFieldType fieldType) const; - void RemoveAllHighLights(); - void SetHighlightAlpha(uint8_t alpha) { m_HighlightAlpha = alpha; } - uint8_t GetHighlightAlpha() { return m_HighlightAlpha; } - void SetHighlightColor(FX_COLORREF clr, FormFieldType fieldType); - void SetAllHighlightColors(FX_COLORREF clr); - FX_COLORREF GetHighlightColor(FormFieldType fieldType); - - private: - // IPDF_FormNotify: - bool BeforeValueChange(CPDF_FormField* pField, - const WideString& csValue) override; - void AfterValueChange(CPDF_FormField* pField) override; - bool BeforeSelectionChange(CPDF_FormField* pField, - const WideString& csValue) override; - void AfterSelectionChange(CPDF_FormField* pField) override; - void AfterCheckedStatusChange(CPDF_FormField* pField) override; - void AfterFormReset(CPDF_InterForm* pForm) override; - - int GetPageIndexByAnnotDict(CPDF_Document* pDocument, - CPDF_Dictionary* pAnnotDict) const; - - UnownedPtr const m_pFormFillEnv; - std::unique_ptr const m_pInterForm; - std::map m_Map; -#ifdef PDF_ENABLE_XFA - std::map m_XFAMap; - bool m_bXfaCalculate = true; - bool m_bXfaValidationsEnabled = true; -#endif // PDF_ENABLE_XFA - bool m_bCalculate = true; - bool m_bBusy = false; - - uint8_t m_HighlightAlpha = 0; - FX_COLORREF m_HighlightColor[kFormFieldTypeCount]; - bool m_NeedsHighlight[kFormFieldTypeCount]; -}; - -#endif // FPDFSDK_CPDFSDK_INTERFORM_H_ diff --git a/fpdfsdk/cpdfsdk_pageview.cpp b/fpdfsdk/cpdfsdk_pageview.cpp index 408dba4b2e..7a49dfe412 100644 --- a/fpdfsdk/cpdfsdk_pageview.cpp +++ b/fpdfsdk/cpdfsdk_pageview.cpp @@ -13,12 +13,12 @@ #include "core/fpdfapi/parser/cpdf_document.h" #include "core/fpdfapi/render/cpdf_renderoptions.h" #include "core/fpdfdoc/cpdf_annotlist.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fxcrt/autorestorer.h" #include "fpdfsdk/cpdfsdk_annot.h" #include "fpdfsdk/cpdfsdk_annotiteration.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "third_party/base/ptr_util.h" #ifdef PDF_ENABLE_XFA diff --git a/fpdfsdk/cpdfsdk_widget.cpp b/fpdfsdk/cpdfsdk_widget.cpp index 727035122d..f41d230d1c 100644 --- a/fpdfsdk/cpdfsdk_widget.cpp +++ b/fpdfsdk/cpdfsdk_widget.cpp @@ -19,14 +19,14 @@ #include "core/fpdfdoc/cpdf_formcontrol.h" #include "core/fpdfdoc/cpdf_formfield.h" #include "core/fpdfdoc/cpdf_iconfit.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fxge/cfx_graphstatedata.h" #include "core/fxge/cfx_pathdata.h" #include "core/fxge/cfx_renderdevice.h" #include "fpdfsdk/cpdfsdk_actionhandler.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" #include "fpdfsdk/cpdfsdk_helpers.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/formfiller/cba_fontmap.h" #include "fpdfsdk/pwl/cpwl_appstream.h" diff --git a/fpdfsdk/cpdfsdk_widgethandler.cpp b/fpdfsdk/cpdfsdk_widgethandler.cpp index 7dfedad2cd..70528d8d52 100644 --- a/fpdfsdk/cpdfsdk_widgethandler.cpp +++ b/fpdfsdk/cpdfsdk_widgethandler.cpp @@ -11,10 +11,10 @@ #include "core/fpdfapi/page/cpdf_page.h" #include "core/fpdfapi/parser/cpdf_document.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "fpdfsdk/cpdfsdk_annot.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_widget.h" #include "fpdfsdk/formfiller/cffl_formfiller.h" diff --git a/fpdfsdk/cpdfsdk_xfawidgethandler.cpp b/fpdfsdk/cpdfsdk_xfawidgethandler.cpp index 1660f86af3..cc49c31d0b 100644 --- a/fpdfsdk/cpdfsdk_xfawidgethandler.cpp +++ b/fpdfsdk/cpdfsdk_xfawidgethandler.cpp @@ -6,10 +6,10 @@ #include "fpdfsdk/cpdfsdk_xfawidgethandler.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "fpdfsdk/cpdfsdk_annot.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_xfawidget.h" #include "fpdfsdk/fpdfxfa/cpdfxfa_context.h" diff --git a/fpdfsdk/formfiller/cffl_interactiveformfiller.cpp b/fpdfsdk/formfiller/cffl_interactiveformfiller.cpp index e1d28c86b2..d5ca80222f 100644 --- a/fpdfsdk/formfiller/cffl_interactiveformfiller.cpp +++ b/fpdfsdk/formfiller/cffl_interactiveformfiller.cpp @@ -13,7 +13,7 @@ #include "core/fxge/cfx_pathdata.h" #include "core/fxge/cfx_renderdevice.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_widget.h" #include "fpdfsdk/formfiller/cffl_checkbox.h" diff --git a/fpdfsdk/fpdf_annot.cpp b/fpdfsdk/fpdf_annot.cpp index fe7d9fa012..8595357488 100644 --- a/fpdfsdk/fpdf_annot.cpp +++ b/fpdfsdk/fpdf_annot.cpp @@ -19,7 +19,7 @@ #include "core/fpdfapi/parser/cpdf_string.h" #include "core/fpdfdoc/cpdf_annot.h" #include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpvt_generateap.h" #include "core/fxge/cfx_color.h" #include "fpdfsdk/cpdf_annotcontext.h" diff --git a/fpdfsdk/fpdf_ext.cpp b/fpdfsdk/fpdf_ext.cpp index 94c84dfb8f..1ff27cc94d 100644 --- a/fpdfsdk/fpdf_ext.cpp +++ b/fpdfsdk/fpdf_ext.cpp @@ -9,7 +9,7 @@ #include "core/fpdfapi/cpdf_modulemgr.h" #include "core/fpdfapi/parser/cpdf_dictionary.h" #include "core/fpdfapi/parser/cpdf_document.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpdf_metadata.h" #include "core/fxcrt/fx_extension.h" #include "fpdfsdk/cpdfsdk_helpers.h" diff --git a/fpdfsdk/fpdf_formfill.cpp b/fpdfsdk/fpdf_formfill.cpp index 1d3f06fc1e..203017798b 100644 --- a/fpdfsdk/fpdf_formfill.cpp +++ b/fpdfsdk/fpdf_formfill.cpp @@ -15,13 +15,13 @@ #include "core/fpdfapi/render/cpdf_renderoptions.h" #include "core/fpdfdoc/cpdf_formcontrol.h" #include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpdf_occontext.h" #include "core/fxge/cfx_defaultrenderdevice.h" #include "fpdfsdk/cpdfsdk_actionhandler.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" #include "fpdfsdk/cpdfsdk_helpers.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "public/fpdfview.h" #include "third_party/base/ptr_util.h" diff --git a/fpdfsdk/fpdfxfa/cpdfxfa_docenvironment.cpp b/fpdfsdk/fpdfxfa/cpdfxfa_docenvironment.cpp index d95d242c48..8c89895292 100644 --- a/fpdfsdk/fpdfxfa/cpdfxfa_docenvironment.cpp +++ b/fpdfsdk/fpdfxfa/cpdfxfa_docenvironment.cpp @@ -15,7 +15,7 @@ #include "core/fpdfapi/parser/cpdf_string.h" #include "core/fxcrt/retain_ptr.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/fpdfxfa/cpdfxfa_context.h" #include "fpdfsdk/fpdfxfa/cpdfxfa_page.h" diff --git a/fpdfsdk/pwl/cpwl_appstream.cpp b/fpdfsdk/pwl/cpwl_appstream.cpp index d2ffd2a9b1..dd86ef5d32 100644 --- a/fpdfsdk/pwl/cpwl_appstream.cpp +++ b/fpdfsdk/pwl/cpwl_appstream.cpp @@ -18,7 +18,7 @@ #include "core/fpdfapi/parser/fpdf_parser_decode.h" #include "core/fpdfdoc/cpvt_word.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_widget.h" #include "fpdfsdk/formfiller/cba_fontmap.h" diff --git a/fxjs/cjs_app.cpp b/fxjs/cjs_app.cpp index 7c9cb229a7..c51bd9dca2 100644 --- a/fxjs/cjs_app.cpp +++ b/fxjs/cjs_app.cpp @@ -8,7 +8,7 @@ #include -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fxjs/cjs_document.h" #include "fxjs/cjs_timerobj.h" #include "fxjs/global_timer.h" diff --git a/fxjs/cjs_document.cpp b/fxjs/cjs_document.cpp index 497bc08e4e..483124acf4 100644 --- a/fxjs/cjs_document.cpp +++ b/fxjs/cjs_document.cpp @@ -15,10 +15,10 @@ #include "core/fpdfapi/parser/cpdf_dictionary.h" #include "core/fpdfapi/parser/cpdf_name.h" #include "core/fpdfapi/parser/cpdf_string.h" -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fpdfdoc/cpdf_nametree.h" #include "fpdfsdk/cpdfsdk_annotiteration.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fxjs/cjs_annot.h" #include "fxjs/cjs_app.h" diff --git a/fxjs/cjs_field.cpp b/fxjs/cjs_field.cpp index cffefeb8c7..628eb440df 100644 --- a/fxjs/cjs_field.cpp +++ b/fxjs/cjs_field.cpp @@ -12,8 +12,8 @@ #include "core/fpdfapi/font/cpdf_font.h" #include "core/fpdfdoc/cpdf_formfield.h" -#include "core/fpdfdoc/cpdf_interform.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fpdfsdk/cpdfsdk_pageview.h" #include "fpdfsdk/cpdfsdk_widget.h" #include "fxjs/cjs_color.h" diff --git a/fxjs/cjs_publicmethods.cpp b/fxjs/cjs_publicmethods.cpp index 3cf70ccf3a..fb2df6a716 100644 --- a/fxjs/cjs_publicmethods.cpp +++ b/fxjs/cjs_publicmethods.cpp @@ -17,10 +17,10 @@ #include #include -#include "core/fpdfdoc/cpdf_interform.h" +#include "core/fpdfdoc/cpdf_interactiveform.h" #include "core/fxcrt/fx_extension.h" #include "fpdfsdk/cpdfsdk_formfillenvironment.h" -#include "fpdfsdk/cpdfsdk_interform.h" +#include "fpdfsdk/cpdfsdk_interactiveform.h" #include "fxjs/cjs_color.h" #include "fxjs/cjs_event_context.h" #include "fxjs/cjs_eventhandler.h" -- cgit v1.2.3