blob: 2f888b4486ddf4fc30ea4cd98969f760e3e84ae6 [file] [log] [blame]
jaepark611adb82016-08-17 11:34:36 -07001// Copyright 2016 PDFium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
Lei Zhangc3450652018-10-11 16:54:42 +00007#include "fpdfsdk/cpdfsdk_interactiveform.h"
jaepark611adb82016-08-17 11:34:36 -07008
9#include <algorithm>
10#include <memory>
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -040011#include <sstream>
12#include <string>
Tom Sepeze005dc32018-06-19 17:33:32 +000013#include <utility>
thestig7c292e02016-09-28 14:14:26 -070014#include <vector>
jaepark611adb82016-08-17 11:34:36 -070015
Lei Zhang85549b42019-02-02 00:40:19 +000016#include "constants/annotation_flags.h"
dsinclair41872fa2016-10-04 11:29:35 -070017#include "core/fpdfapi/page/cpdf_page.h"
dsinclair488b7ad2016-10-04 11:55:50 -070018#include "core/fpdfapi/parser/cfdf_document.h"
19#include "core/fpdfapi/parser/cpdf_array.h"
Lei Zhang81535612018-10-09 21:15:17 +000020#include "core/fpdfapi/parser/cpdf_dictionary.h"
dsinclair488b7ad2016-10-04 11:55:50 -070021#include "core/fpdfapi/parser/cpdf_document.h"
22#include "core/fpdfapi/parser/cpdf_stream.h"
dsinclair1727aee2016-09-29 13:12:56 -070023#include "core/fpdfdoc/cpdf_actionfields.h"
Tom Sepezc90cf382019-08-12 19:09:23 +000024#include "core/fpdfdoc/cpdf_formcontrol.h"
Lei Zhangc3450652018-10-11 16:54:42 +000025#include "core/fpdfdoc/cpdf_interactiveform.h"
Tom Sepezc22d6712018-06-05 22:33:31 +000026#include "core/fxcrt/autorestorer.h"
dsinclair74a34fc2016-09-29 16:41:42 -070027#include "core/fxge/cfx_graphstatedata.h"
28#include "core/fxge/cfx_pathdata.h"
Dan Sinclair7d125322018-03-28 18:49:34 +000029#include "fpdfsdk/cpdfsdk_actionhandler.h"
dsinclair114e46a2016-09-29 17:18:21 -070030#include "fpdfsdk/cpdfsdk_annot.h"
Dan Sinclaircbf76e62018-03-28 21:00:35 +000031#include "fpdfsdk/cpdfsdk_annotiterator.h"
dsinclair735606d2016-10-05 15:47:02 -070032#include "fpdfsdk/cpdfsdk_formfillenvironment.h"
dsinclair114e46a2016-09-29 17:18:21 -070033#include "fpdfsdk/cpdfsdk_pageview.h"
34#include "fpdfsdk/cpdfsdk_widget.h"
jaepark611adb82016-08-17 11:34:36 -070035#include "fpdfsdk/formfiller/cffl_formfiller.h"
dsinclair114e46a2016-09-29 17:18:21 -070036#include "fpdfsdk/ipdfsdk_annothandler.h"
Dan Sinclaire0345a42017-10-30 20:20:42 +000037#include "fxjs/ijs_event_context.h"
38#include "fxjs/ijs_runtime.h"
Lei Zhang99f5bbb2018-10-09 21:31:28 +000039#include "third_party/base/ptr_util.h"
jaepark611adb82016-08-17 11:34:36 -070040
Ryan Harrison9baf31f2018-01-12 18:36:30 +000041namespace {
42
Lei Zhang4f7479a2018-03-21 13:37:06 +000043constexpr uint32_t kWhiteBGR = FXSYS_BGR(255, 255, 255);
44
Ryan Harrison9baf31f2018-01-12 18:36:30 +000045bool IsFormFieldTypeComboOrText(FormFieldType fieldType) {
46 switch (fieldType) {
47 case FormFieldType::kComboBox:
48 case FormFieldType::kTextField:
49 return true;
50 default:
51 return false;
52 }
53}
54
Ryan Harrison2056fac2018-01-16 16:06:45 +000055#ifdef PDF_ENABLE_XFA
56bool IsFormFieldTypeXFA(FormFieldType fieldType) {
57 switch (fieldType) {
58 case FormFieldType::kXFA:
59 case FormFieldType::kXFA_CheckBox:
60 case FormFieldType::kXFA_ComboBox:
61 case FormFieldType::kXFA_ImageField:
62 case FormFieldType::kXFA_ListBox:
63 case FormFieldType::kXFA_PushButton:
64 case FormFieldType::kXFA_Signature:
65 case FormFieldType::kXFA_TextField:
66 return true;
67 default:
68 return false;
69 }
70}
71#endif // PDF_ENABLE_XFA
72
Lei Zhang2ee811f2018-08-13 21:32:50 +000073bool FDFToURLEncodedData(std::vector<uint8_t>* pBuffer) {
Lei Zhangf0260b22018-08-13 22:50:02 +000074 std::unique_ptr<CFDF_Document> pFDF = CFDF_Document::ParseMemory(*pBuffer);
Lei Zhang4f1aa692018-08-13 21:31:18 +000075 if (!pFDF)
76 return true;
77
78 CPDF_Dictionary* pMainDict = pFDF->GetRoot()->GetDictFor("FDF");
79 if (!pMainDict)
80 return false;
81
82 CPDF_Array* pFields = pMainDict->GetArrayFor("Fields");
83 if (!pFields)
84 return false;
85
86 std::ostringstream fdfEncodedData;
Lei Zhangf40380f2018-10-12 18:31:51 +000087 for (uint32_t i = 0; i < pFields->size(); i++) {
Lei Zhang4f1aa692018-08-13 21:31:18 +000088 CPDF_Dictionary* pField = pFields->GetDictAt(i);
89 if (!pField)
90 continue;
91 WideString name;
92 name = pField->GetUnicodeTextFor("T");
93 ByteString name_b = name.ToDefANSI();
94 ByteString csBValue = pField->GetStringFor("V");
Tom Sepez24b3a202019-07-22 17:47:48 +000095 WideString csWValue = PDF_DecodeText(csBValue.raw_span());
Lei Zhang4f1aa692018-08-13 21:31:18 +000096 ByteString csValue_b = csWValue.ToDefANSI();
97 fdfEncodedData << name_b << "=" << csValue_b;
Lei Zhangf40380f2018-10-12 18:31:51 +000098 if (i != pFields->size() - 1)
Lei Zhang4f1aa692018-08-13 21:31:18 +000099 fdfEncodedData << "&";
100 }
101
Lei Zhang2ee811f2018-08-13 21:32:50 +0000102 size_t nBufSize = fdfEncodedData.tellp();
Lei Zhang4f1aa692018-08-13 21:31:18 +0000103 if (nBufSize <= 0)
104 return false;
105
Lei Zhang2ee811f2018-08-13 21:32:50 +0000106 pBuffer->resize(nBufSize);
107 memcpy(pBuffer->data(), fdfEncodedData.str().c_str(), nBufSize);
Lei Zhang4f1aa692018-08-13 21:31:18 +0000108 return true;
109}
110
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000111} // namespace
112
Lei Zhang073ecf42018-10-11 16:56:00 +0000113CPDFSDK_InteractiveForm::CPDFSDK_InteractiveForm(
114 CPDFSDK_FormFillEnvironment* pFormFillEnv)
dsinclair690c0332016-10-11 09:13:01 -0700115 : m_pFormFillEnv(pFormFillEnv),
Lei Zhang073ecf42018-10-11 16:56:00 +0000116 m_pInteractiveForm(pdfium::MakeUnique<CPDF_InteractiveForm>(
Lei Zhang461acb22018-10-10 18:38:03 +0000117 m_pFormFillEnv->GetPDFDocument())) {
118 ASSERT(m_pFormFillEnv);
Lei Zhang073ecf42018-10-11 16:56:00 +0000119 m_pInteractiveForm->SetFormNotify(this);
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000120 RemoveAllHighLights();
jaepark611adb82016-08-17 11:34:36 -0700121}
122
Tom Sepezc0ccf6d2019-08-16 22:04:58 +0000123CPDFSDK_InteractiveForm::~CPDFSDK_InteractiveForm() = default;
jaepark611adb82016-08-17 11:34:36 -0700124
Lei Zhang073ecf42018-10-11 16:56:00 +0000125CPDFSDK_Widget* CPDFSDK_InteractiveForm::GetWidget(
126 CPDF_FormControl* pControl) const {
Lei Zhang461acb22018-10-10 18:38:03 +0000127 if (!pControl)
jaepark611adb82016-08-17 11:34:36 -0700128 return nullptr;
129
130 CPDFSDK_Widget* pWidget = nullptr;
131 const auto it = m_Map.find(pControl);
132 if (it != m_Map.end())
133 pWidget = it->second;
134 if (pWidget)
135 return pWidget;
jaepark611adb82016-08-17 11:34:36 -0700136
137 CPDF_Dictionary* pControlDict = pControl->GetWidget();
dsinclair7cbe68e2016-10-12 11:56:23 -0700138 CPDF_Document* pDocument = m_pFormFillEnv->GetPDFDocument();
jaepark611adb82016-08-17 11:34:36 -0700139 CPDFSDK_PageView* pPage = nullptr;
140
dsinclair38fd8442016-09-15 10:15:32 -0700141 if (CPDF_Dictionary* pPageDict = pControlDict->GetDictFor("P")) {
jaepark611adb82016-08-17 11:34:36 -0700142 int nPageIndex = pDocument->GetPageIndex(pPageDict->GetObjNum());
143 if (nPageIndex >= 0)
dsinclair7cbe68e2016-10-12 11:56:23 -0700144 pPage = m_pFormFillEnv->GetPageView(nPageIndex);
jaepark611adb82016-08-17 11:34:36 -0700145 }
146
147 if (!pPage) {
148 int nPageIndex = GetPageIndexByAnnotDict(pDocument, pControlDict);
149 if (nPageIndex >= 0)
dsinclair7cbe68e2016-10-12 11:56:23 -0700150 pPage = m_pFormFillEnv->GetPageView(nPageIndex);
jaepark611adb82016-08-17 11:34:36 -0700151 }
152
Tom Sepez4ef943b2018-07-26 19:06:06 +0000153 return pPage ? ToCPDFSDKWidget(pPage->GetAnnotByDict(pControlDict)) : nullptr;
jaepark611adb82016-08-17 11:34:36 -0700154}
155
Lei Zhang073ecf42018-10-11 16:56:00 +0000156void CPDFSDK_InteractiveForm::GetWidgets(
Ryan Harrison275e2602017-09-18 14:23:18 -0400157 const WideString& sFieldName,
Tom Sepezd8ae8f82019-06-12 17:58:33 +0000158 std::vector<ObservedPtr<CPDFSDK_Annot>>* widgets) const {
Lei Zhang073ecf42018-10-11 16:56:00 +0000159 for (int i = 0, sz = m_pInteractiveForm->CountFields(sFieldName); i < sz;
160 ++i) {
161 CPDF_FormField* pFormField = m_pInteractiveForm->GetField(i, sFieldName);
jaepark611adb82016-08-17 11:34:36 -0700162 ASSERT(pFormField);
163 GetWidgets(pFormField, widgets);
164 }
165}
166
Lei Zhang073ecf42018-10-11 16:56:00 +0000167void CPDFSDK_InteractiveForm::GetWidgets(
jaepark611adb82016-08-17 11:34:36 -0700168 CPDF_FormField* pField,
Tom Sepezd8ae8f82019-06-12 17:58:33 +0000169 std::vector<ObservedPtr<CPDFSDK_Annot>>* widgets) const {
jaepark611adb82016-08-17 11:34:36 -0700170 for (int i = 0, sz = pField->CountControls(); i < sz; ++i) {
171 CPDF_FormControl* pFormCtrl = pField->GetControl(i);
172 ASSERT(pFormCtrl);
dsinclairc5267c52016-11-04 15:35:12 -0700173 CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl);
jaepark611adb82016-08-17 11:34:36 -0700174 if (pWidget)
tsepez8fa82792017-01-11 09:32:33 -0800175 widgets->emplace_back(pWidget);
jaepark611adb82016-08-17 11:34:36 -0700176 }
177}
178
Lei Zhang073ecf42018-10-11 16:56:00 +0000179int CPDFSDK_InteractiveForm::GetPageIndexByAnnotDict(
jaepark611adb82016-08-17 11:34:36 -0700180 CPDF_Document* pDocument,
181 CPDF_Dictionary* pAnnotDict) const {
182 ASSERT(pAnnotDict);
183
184 for (int i = 0, sz = pDocument->GetPageCount(); i < sz; i++) {
Tom Sepez967aa072018-05-08 13:40:20 +0000185 if (CPDF_Dictionary* pPageDict = pDocument->GetPageDictionary(i)) {
dsinclair38fd8442016-09-15 10:15:32 -0700186 if (CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots")) {
Lei Zhangf40380f2018-10-12 18:31:51 +0000187 for (int j = 0, jsz = pAnnots->size(); j < jsz; j++) {
jaepark611adb82016-08-17 11:34:36 -0700188 CPDF_Object* pDict = pAnnots->GetDirectObjectAt(j);
189 if (pAnnotDict == pDict)
190 return i;
191 }
192 }
193 }
194 }
195
196 return -1;
197}
198
Lei Zhang073ecf42018-10-11 16:56:00 +0000199void CPDFSDK_InteractiveForm::AddMap(CPDF_FormControl* pControl,
200 CPDFSDK_Widget* pWidget) {
jaepark611adb82016-08-17 11:34:36 -0700201 m_Map[pControl] = pWidget;
202}
203
Lei Zhang073ecf42018-10-11 16:56:00 +0000204void CPDFSDK_InteractiveForm::RemoveMap(CPDF_FormControl* pControl) {
jaepark611adb82016-08-17 11:34:36 -0700205 m_Map.erase(pControl);
206}
207
Lei Zhang073ecf42018-10-11 16:56:00 +0000208void CPDFSDK_InteractiveForm::EnableCalculate(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700209 m_bCalculate = bEnabled;
210}
211
Lei Zhang073ecf42018-10-11 16:56:00 +0000212bool CPDFSDK_InteractiveForm::IsCalculateEnabled() const {
jaepark611adb82016-08-17 11:34:36 -0700213 return m_bCalculate;
214}
215
216#ifdef PDF_ENABLE_XFA
Lei Zhang073ecf42018-10-11 16:56:00 +0000217void CPDFSDK_InteractiveForm::XfaEnableCalculate(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700218 m_bXfaCalculate = bEnabled;
219}
Tom Sepezc0ccf6d2019-08-16 22:04:58 +0000220
Lei Zhang073ecf42018-10-11 16:56:00 +0000221bool CPDFSDK_InteractiveForm::IsXfaCalculateEnabled() const {
jaepark611adb82016-08-17 11:34:36 -0700222 return m_bXfaCalculate;
223}
224
Lei Zhang073ecf42018-10-11 16:56:00 +0000225bool CPDFSDK_InteractiveForm::IsXfaValidationsEnabled() {
jaepark611adb82016-08-17 11:34:36 -0700226 return m_bXfaValidationsEnabled;
227}
Lei Zhang073ecf42018-10-11 16:56:00 +0000228void CPDFSDK_InteractiveForm::XfaSetValidationsEnabled(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700229 m_bXfaValidationsEnabled = bEnabled;
230}
231
Lei Zhang073ecf42018-10-11 16:56:00 +0000232void CPDFSDK_InteractiveForm::SynchronizeField(CPDF_FormField* pFormField) {
jaepark611adb82016-08-17 11:34:36 -0700233 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
234 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
dsinclairc5267c52016-11-04 15:35:12 -0700235 if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl))
Dan Sinclairce047a62018-01-30 18:15:02 +0000236 pWidget->Synchronize(false);
jaepark611adb82016-08-17 11:34:36 -0700237 }
238}
239#endif // PDF_ENABLE_XFA
240
Lei Zhang073ecf42018-10-11 16:56:00 +0000241void CPDFSDK_InteractiveForm::OnCalculate(CPDF_FormField* pFormField) {
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000242 if (!m_pFormFillEnv->IsJSPlatformPresent())
jaepark611adb82016-08-17 11:34:36 -0700243 return;
244
245 if (m_bBusy)
246 return;
247
Tom Sepezc22d6712018-06-05 22:33:31 +0000248 AutoRestorer<bool> restorer(&m_bBusy);
tsepez4cf55152016-11-02 14:37:54 -0700249 m_bBusy = true;
jaepark611adb82016-08-17 11:34:36 -0700250
Tom Sepezc22d6712018-06-05 22:33:31 +0000251 if (!IsCalculateEnabled())
jaepark611adb82016-08-17 11:34:36 -0700252 return;
jaepark611adb82016-08-17 11:34:36 -0700253
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000254 IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime();
Lei Zhang073ecf42018-10-11 16:56:00 +0000255 int nSize = m_pInteractiveForm->CountFieldsInCalculationOrder();
jaepark611adb82016-08-17 11:34:36 -0700256 for (int i = 0; i < nSize; i++) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000257 CPDF_FormField* pField = m_pInteractiveForm->GetFieldInCalculationOrder(i);
jaepark611adb82016-08-17 11:34:36 -0700258 if (!pField)
259 continue;
260
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000261 FormFieldType fieldType = pField->GetFieldType();
262 if (!IsFormFieldTypeComboOrText(fieldType))
jaepark611adb82016-08-17 11:34:36 -0700263 continue;
264
265 CPDF_AAction aAction = pField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000266 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kCalculate))
jaepark611adb82016-08-17 11:34:36 -0700267 continue;
268
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000269 CPDF_Action action = aAction.GetAction(CPDF_AAction::kCalculate);
jaepark611adb82016-08-17 11:34:36 -0700270 if (!action.GetDict())
271 continue;
272
Ryan Harrison275e2602017-09-18 14:23:18 -0400273 WideString csJS = action.GetJavaScript();
jaepark611adb82016-08-17 11:34:36 -0700274 if (csJS.IsEmpty())
275 continue;
276
Ryan Harrison275e2602017-09-18 14:23:18 -0400277 WideString sOldValue = pField->GetValue();
278 WideString sValue = sOldValue;
tsepez4cf55152016-11-02 14:37:54 -0700279 bool bRC = true;
Tom Sepezc22d6712018-06-05 22:33:31 +0000280 IJS_Runtime::ScopedEventContext pContext(pRuntime);
Tom Sepez3d813152018-06-21 17:28:24 +0000281 pContext->OnField_Calculate(pFormField, pField, &sValue, &bRC);
jaepark611adb82016-08-17 11:34:36 -0700282
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000283 Optional<IJS_Runtime::JS_Error> err = pContext->RunScript(csJS);
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000284 if (!err && bRC && sValue.Compare(sOldValue) != 0)
Tom Sepezb2e6b4c2018-08-16 20:53:58 +0000285 pField->SetValue(sValue, NotificationOption::kNotify);
jaepark611adb82016-08-17 11:34:36 -0700286 }
jaepark611adb82016-08-17 11:34:36 -0700287}
288
Lei Zhang073ecf42018-10-11 16:56:00 +0000289Optional<WideString> CPDFSDK_InteractiveForm::OnFormat(
290 CPDF_FormField* pFormField) {
Lei Zhang4f261ff2018-10-10 18:44:45 +0000291 if (!m_pFormFillEnv->IsJSPlatformPresent())
292 return {};
jaepark611adb82016-08-17 11:34:36 -0700293
Lei Zhang4f261ff2018-10-10 18:44:45 +0000294 WideString sValue = pFormField->GetValue();
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000295 IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime();
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000296 if (pFormField->GetFieldType() == FormFieldType::kComboBox &&
jaepark611adb82016-08-17 11:34:36 -0700297 pFormField->CountSelectedItems() > 0) {
298 int index = pFormField->GetSelectedIndex(0);
299 if (index >= 0)
300 sValue = pFormField->GetOptionLabel(index);
301 }
302
jaepark611adb82016-08-17 11:34:36 -0700303 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000304 if (aAction.GetDict() && aAction.ActionExist(CPDF_AAction::kFormat)) {
305 CPDF_Action action = aAction.GetAction(CPDF_AAction::kFormat);
jaepark611adb82016-08-17 11:34:36 -0700306 if (action.GetDict()) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400307 WideString script = action.GetJavaScript();
jaepark611adb82016-08-17 11:34:36 -0700308 if (!script.IsEmpty()) {
Tom Sepezc22d6712018-06-05 22:33:31 +0000309 IJS_Runtime::ScopedEventContext pContext(pRuntime);
Lei Zhang4f261ff2018-10-10 18:44:45 +0000310 pContext->OnField_Format(pFormField, &sValue, true);
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000311 Optional<IJS_Runtime::JS_Error> err = pContext->RunScript(script);
Lei Zhang4f261ff2018-10-10 18:44:45 +0000312 if (!err)
313 return sValue;
jaepark611adb82016-08-17 11:34:36 -0700314 }
315 }
316 }
Lei Zhang4f261ff2018-10-10 18:44:45 +0000317 return {};
jaepark611adb82016-08-17 11:34:36 -0700318}
319
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000320void CPDFSDK_InteractiveForm::ResetFieldAppearance(
321 CPDF_FormField* pFormField,
322 Optional<WideString> sValue) {
jaepark611adb82016-08-17 11:34:36 -0700323 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
324 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
325 ASSERT(pFormCtrl);
dsinclairc5267c52016-11-04 15:35:12 -0700326 if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl))
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000327 pWidget->ResetAppearance(sValue, true);
jaepark611adb82016-08-17 11:34:36 -0700328 }
329}
330
Lei Zhang073ecf42018-10-11 16:56:00 +0000331void CPDFSDK_InteractiveForm::UpdateField(CPDF_FormField* pFormField) {
Lei Zhang375c2762017-03-10 14:37:14 -0800332 auto* formfiller = m_pFormFillEnv->GetInteractiveFormFiller();
jaepark611adb82016-08-17 11:34:36 -0700333 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
334 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
335 ASSERT(pFormCtrl);
336
Lei Zhang77f9bff2017-08-29 11:34:12 -0700337 CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl);
338 if (!pWidget)
339 continue;
340
Tom Sepez101535f2018-06-12 13:36:05 +0000341 IPDF_Page* pPage = pWidget->GetPage();
Lei Zhang77f9bff2017-08-29 11:34:12 -0700342 FX_RECT rect = formfiller->GetViewBBox(
343 m_pFormFillEnv->GetPageView(pPage, false), pWidget);
344 m_pFormFillEnv->Invalidate(pPage, rect);
jaepark611adb82016-08-17 11:34:36 -0700345 }
346}
347
Lei Zhang073ecf42018-10-11 16:56:00 +0000348bool CPDFSDK_InteractiveForm::OnKeyStrokeCommit(CPDF_FormField* pFormField,
349 const WideString& csValue) {
jaepark611adb82016-08-17 11:34:36 -0700350 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000351 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kKeyStroke))
tsepez4cf55152016-11-02 14:37:54 -0700352 return true;
jaepark611adb82016-08-17 11:34:36 -0700353
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000354 CPDF_Action action = aAction.GetAction(CPDF_AAction::kKeyStroke);
jaepark611adb82016-08-17 11:34:36 -0700355 if (!action.GetDict())
tsepez4cf55152016-11-02 14:37:54 -0700356 return true;
jaepark611adb82016-08-17 11:34:36 -0700357
Dan Sinclair7d125322018-03-28 18:49:34 +0000358 CPDFSDK_FieldAction fa;
Lei Zhang60fa2fc2017-07-21 17:42:19 -0700359 fa.bModifier = false;
360 fa.bShift = false;
jaepark611adb82016-08-17 11:34:36 -0700361 fa.sValue = csValue;
Lei Zhang7db136a2018-10-10 21:34:17 +0000362 m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript(
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000363 action, CPDF_AAction::kKeyStroke, m_pFormFillEnv.Get(), pFormField, &fa);
jaepark611adb82016-08-17 11:34:36 -0700364 return fa.bRC;
365}
366
Lei Zhang073ecf42018-10-11 16:56:00 +0000367bool CPDFSDK_InteractiveForm::OnValidate(CPDF_FormField* pFormField,
368 const WideString& csValue) {
jaepark611adb82016-08-17 11:34:36 -0700369 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000370 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kValidate))
tsepez4cf55152016-11-02 14:37:54 -0700371 return true;
jaepark611adb82016-08-17 11:34:36 -0700372
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000373 CPDF_Action action = aAction.GetAction(CPDF_AAction::kValidate);
jaepark611adb82016-08-17 11:34:36 -0700374 if (!action.GetDict())
tsepez4cf55152016-11-02 14:37:54 -0700375 return true;
jaepark611adb82016-08-17 11:34:36 -0700376
Dan Sinclair7d125322018-03-28 18:49:34 +0000377 CPDFSDK_FieldAction fa;
Lei Zhang60fa2fc2017-07-21 17:42:19 -0700378 fa.bModifier = false;
379 fa.bShift = false;
jaepark611adb82016-08-17 11:34:36 -0700380 fa.sValue = csValue;
Lei Zhang7db136a2018-10-10 21:34:17 +0000381 m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript(
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000382 action, CPDF_AAction::kValidate, m_pFormFillEnv.Get(), pFormField, &fa);
jaepark611adb82016-08-17 11:34:36 -0700383 return fa.bRC;
384}
385
Lei Zhang073ecf42018-10-11 16:56:00 +0000386bool CPDFSDK_InteractiveForm::DoAction_Hide(const CPDF_Action& action) {
jaepark611adb82016-08-17 11:34:36 -0700387 ASSERT(action.GetDict());
388
389 CPDF_ActionFields af(&action);
Lei Zhang5cee3f22018-05-25 21:48:49 +0000390 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700391 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
392
393 bool bHide = action.GetHideStatus();
tsepez4cf55152016-11-02 14:37:54 -0700394 bool bChanged = false;
jaepark611adb82016-08-17 11:34:36 -0700395
396 for (CPDF_FormField* pField : fields) {
397 for (int i = 0, sz = pField->CountControls(); i < sz; ++i) {
398 CPDF_FormControl* pControl = pField->GetControl(i);
399 ASSERT(pControl);
400
dsinclairc5267c52016-11-04 15:35:12 -0700401 if (CPDFSDK_Widget* pWidget = GetWidget(pControl)) {
jaepark611adb82016-08-17 11:34:36 -0700402 uint32_t nFlags = pWidget->GetFlags();
Lei Zhang85549b42019-02-02 00:40:19 +0000403 nFlags &= ~pdfium::annotation_flags::kInvisible;
404 nFlags &= ~pdfium::annotation_flags::kNoView;
jaepark611adb82016-08-17 11:34:36 -0700405 if (bHide)
Lei Zhang85549b42019-02-02 00:40:19 +0000406 nFlags |= pdfium::annotation_flags::kHidden;
jaepark611adb82016-08-17 11:34:36 -0700407 else
Lei Zhang85549b42019-02-02 00:40:19 +0000408 nFlags &= ~pdfium::annotation_flags::kHidden;
jaepark611adb82016-08-17 11:34:36 -0700409 pWidget->SetFlags(nFlags);
410 pWidget->GetPageView()->UpdateView(pWidget);
tsepez4cf55152016-11-02 14:37:54 -0700411 bChanged = true;
jaepark611adb82016-08-17 11:34:36 -0700412 }
413 }
414 }
415
416 return bChanged;
417}
418
Lei Zhang073ecf42018-10-11 16:56:00 +0000419bool CPDFSDK_InteractiveForm::DoAction_SubmitForm(const CPDF_Action& action) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400420 WideString sDestination = action.GetFilePath();
jaepark611adb82016-08-17 11:34:36 -0700421 if (sDestination.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700422 return false;
jaepark611adb82016-08-17 11:34:36 -0700423
Lei Zhang5cee3f22018-05-25 21:48:49 +0000424 const CPDF_Dictionary* pActionDict = action.GetDict();
jaepark611adb82016-08-17 11:34:36 -0700425 if (pActionDict->KeyExist("Fields")) {
426 CPDF_ActionFields af(&action);
427 uint32_t dwFlags = action.GetFlags();
Lei Zhang5cee3f22018-05-25 21:48:49 +0000428 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700429 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
430 if (!fields.empty()) {
431 bool bIncludeOrExclude = !(dwFlags & 0x01);
Lei Zhang073ecf42018-10-11 16:56:00 +0000432 if (!m_pInteractiveForm->CheckRequiredFields(&fields, bIncludeOrExclude))
tsepez4cf55152016-11-02 14:37:54 -0700433 return false;
jaepark611adb82016-08-17 11:34:36 -0700434
435 return SubmitFields(sDestination, fields, bIncludeOrExclude, false);
436 }
437 }
Lei Zhang073ecf42018-10-11 16:56:00 +0000438 if (!m_pInteractiveForm->CheckRequiredFields(nullptr, true))
tsepez4cf55152016-11-02 14:37:54 -0700439 return false;
jaepark611adb82016-08-17 11:34:36 -0700440
tsepez4cf55152016-11-02 14:37:54 -0700441 return SubmitForm(sDestination, false);
jaepark611adb82016-08-17 11:34:36 -0700442}
443
Lei Zhang073ecf42018-10-11 16:56:00 +0000444bool CPDFSDK_InteractiveForm::SubmitFields(
445 const WideString& csDestination,
446 const std::vector<CPDF_FormField*>& fields,
447 bool bIncludeOrExclude,
448 bool bUrlEncoded) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400449 ByteString textBuf = ExportFieldsToFDFTextBuf(fields, bIncludeOrExclude);
Tom Sepez65be34f2018-09-14 20:58:36 +0000450 if (textBuf.IsEmpty())
Henrique Nakashimaaea80dc2017-08-01 19:47:24 -0400451 return false;
Henrique Nakashimaaea80dc2017-08-01 19:47:24 -0400452
Tom Sepez65be34f2018-09-14 20:58:36 +0000453 std::vector<uint8_t> buffer(textBuf.begin(), textBuf.end());
Lei Zhang2ee811f2018-08-13 21:32:50 +0000454 if (bUrlEncoded && !FDFToURLEncodedData(&buffer))
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400455 return false;
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400456
Tom Sepeze9703972019-08-09 21:24:29 +0000457 m_pFormFillEnv->SubmitForm(buffer, csDestination);
tsepez4cf55152016-11-02 14:37:54 -0700458 return true;
jaepark611adb82016-08-17 11:34:36 -0700459}
460
Lei Zhang073ecf42018-10-11 16:56:00 +0000461ByteString CPDFSDK_InteractiveForm::ExportFieldsToFDFTextBuf(
jaepark611adb82016-08-17 11:34:36 -0700462 const std::vector<CPDF_FormField*>& fields,
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400463 bool bIncludeOrExclude) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000464 std::unique_ptr<CFDF_Document> pFDF = m_pInteractiveForm->ExportToFDF(
Tom Sepeze9703972019-08-09 21:24:29 +0000465 m_pFormFillEnv->GetFilePath(), fields, bIncludeOrExclude, false);
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400466
Ryan Harrison275e2602017-09-18 14:23:18 -0400467 return pFDF ? pFDF->WriteToString() : ByteString();
jaepark611adb82016-08-17 11:34:36 -0700468}
469
Lei Zhang073ecf42018-10-11 16:56:00 +0000470bool CPDFSDK_InteractiveForm::SubmitForm(const WideString& sDestination,
471 bool bUrlEncoded) {
jaepark611adb82016-08-17 11:34:36 -0700472 if (sDestination.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700473 return false;
jaepark611adb82016-08-17 11:34:36 -0700474
Tom Sepeze9703972019-08-09 21:24:29 +0000475 std::unique_ptr<CFDF_Document> pFDFDoc =
476 m_pInteractiveForm->ExportToFDF(m_pFormFillEnv->GetFilePath(), false);
jaepark611adb82016-08-17 11:34:36 -0700477 if (!pFDFDoc)
tsepez4cf55152016-11-02 14:37:54 -0700478 return false;
jaepark611adb82016-08-17 11:34:36 -0700479
Ryan Harrison275e2602017-09-18 14:23:18 -0400480 ByteString fdfBuffer = pFDFDoc->WriteToString();
Ryan Harrison875e98c2017-09-27 10:53:11 -0400481 if (fdfBuffer.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700482 return false;
jaepark611adb82016-08-17 11:34:36 -0700483
Tom Sepez65be34f2018-09-14 20:58:36 +0000484 std::vector<uint8_t> buffer(fdfBuffer.begin(), fdfBuffer.end());
Lei Zhang2ee811f2018-08-13 21:32:50 +0000485 if (bUrlEncoded && !FDFToURLEncodedData(&buffer))
tsepez4cf55152016-11-02 14:37:54 -0700486 return false;
jaepark611adb82016-08-17 11:34:36 -0700487
Tom Sepeze9703972019-08-09 21:24:29 +0000488 m_pFormFillEnv->SubmitForm(buffer, sDestination);
tsepez4cf55152016-11-02 14:37:54 -0700489 return true;
jaepark611adb82016-08-17 11:34:36 -0700490}
491
Lei Zhang073ecf42018-10-11 16:56:00 +0000492ByteString CPDFSDK_InteractiveForm::ExportFormToFDFTextBuf() {
Tom Sepeze9703972019-08-09 21:24:29 +0000493 std::unique_ptr<CFDF_Document> pFDF =
494 m_pInteractiveForm->ExportToFDF(m_pFormFillEnv->GetFilePath(), false);
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400495
Ryan Harrison275e2602017-09-18 14:23:18 -0400496 return pFDF ? pFDF->WriteToString() : ByteString();
jaepark611adb82016-08-17 11:34:36 -0700497}
498
Lei Zhang073ecf42018-10-11 16:56:00 +0000499void CPDFSDK_InteractiveForm::DoAction_ResetForm(const CPDF_Action& action) {
jaepark611adb82016-08-17 11:34:36 -0700500 ASSERT(action.GetDict());
Lei Zhang5cee3f22018-05-25 21:48:49 +0000501 const CPDF_Dictionary* pActionDict = action.GetDict();
dan sinclair7544a4b2018-03-08 15:19:50 +0000502 if (!pActionDict->KeyExist("Fields")) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000503 m_pInteractiveForm->ResetForm(NotificationOption::kNotify);
dan sinclair7544a4b2018-03-08 15:19:50 +0000504 return;
505 }
jaepark611adb82016-08-17 11:34:36 -0700506 CPDF_ActionFields af(&action);
507 uint32_t dwFlags = action.GetFlags();
Lei Zhang5cee3f22018-05-25 21:48:49 +0000508 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700509 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
Lei Zhang073ecf42018-10-11 16:56:00 +0000510 m_pInteractiveForm->ResetForm(fields, !(dwFlags & 0x01),
511 NotificationOption::kNotify);
jaepark611adb82016-08-17 11:34:36 -0700512}
513
Lei Zhang073ecf42018-10-11 16:56:00 +0000514std::vector<CPDF_FormField*> CPDFSDK_InteractiveForm::GetFieldFromObjects(
Lei Zhang5cee3f22018-05-25 21:48:49 +0000515 const std::vector<const CPDF_Object*>& objects) const {
jaepark611adb82016-08-17 11:34:36 -0700516 std::vector<CPDF_FormField*> fields;
Lei Zhang5cee3f22018-05-25 21:48:49 +0000517 for (const CPDF_Object* pObject : objects) {
Dan Sinclairce047a62018-01-30 18:15:02 +0000518 if (!pObject || !pObject->IsString())
519 continue;
520
521 WideString csName = pObject->GetUnicodeText();
Lei Zhang073ecf42018-10-11 16:56:00 +0000522 CPDF_FormField* pField = m_pInteractiveForm->GetField(0, csName);
Dan Sinclairce047a62018-01-30 18:15:02 +0000523 if (pField)
524 fields.push_back(pField);
jaepark611adb82016-08-17 11:34:36 -0700525 }
526 return fields;
527}
528
Lei Zhang073ecf42018-10-11 16:56:00 +0000529bool CPDFSDK_InteractiveForm::BeforeValueChange(CPDF_FormField* pField,
530 const WideString& csValue) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000531 FormFieldType fieldType = pField->GetFieldType();
532 if (!IsFormFieldTypeComboOrText(fieldType))
dan sinclair507fb4e2018-03-08 15:14:09 +0000533 return true;
jaepark611adb82016-08-17 11:34:36 -0700534 if (!OnKeyStrokeCommit(pField, csValue))
dan sinclair507fb4e2018-03-08 15:14:09 +0000535 return false;
536 return OnValidate(pField, csValue);
jaepark611adb82016-08-17 11:34:36 -0700537}
538
Lei Zhang073ecf42018-10-11 16:56:00 +0000539void CPDFSDK_InteractiveForm::AfterValueChange(CPDF_FormField* pField) {
jaepark611adb82016-08-17 11:34:36 -0700540#ifdef PDF_ENABLE_XFA
Dan Sinclairce047a62018-01-30 18:15:02 +0000541 SynchronizeField(pField);
jaepark611adb82016-08-17 11:34:36 -0700542#endif // PDF_ENABLE_XFA
Dan Sinclairce047a62018-01-30 18:15:02 +0000543
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000544 FormFieldType fieldType = pField->GetFieldType();
Dan Sinclairce047a62018-01-30 18:15:02 +0000545 if (!IsFormFieldTypeComboOrText(fieldType))
546 return;
547
548 OnCalculate(pField);
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000549 ResetFieldAppearance(pField, OnFormat(pField));
Dan Sinclairce047a62018-01-30 18:15:02 +0000550 UpdateField(pField);
jaepark611adb82016-08-17 11:34:36 -0700551}
552
Lei Zhang073ecf42018-10-11 16:56:00 +0000553bool CPDFSDK_InteractiveForm::BeforeSelectionChange(CPDF_FormField* pField,
554 const WideString& csValue) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000555 if (pField->GetFieldType() != FormFieldType::kListBox)
dan sinclair507fb4e2018-03-08 15:14:09 +0000556 return true;
jaepark611adb82016-08-17 11:34:36 -0700557 if (!OnKeyStrokeCommit(pField, csValue))
dan sinclair507fb4e2018-03-08 15:14:09 +0000558 return false;
559 return OnValidate(pField, csValue);
jaepark611adb82016-08-17 11:34:36 -0700560}
561
Lei Zhang073ecf42018-10-11 16:56:00 +0000562void CPDFSDK_InteractiveForm::AfterSelectionChange(CPDF_FormField* pField) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000563 if (pField->GetFieldType() != FormFieldType::kListBox)
jaepark611adb82016-08-17 11:34:36 -0700564 return;
565
566 OnCalculate(pField);
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000567 ResetFieldAppearance(pField, pdfium::nullopt);
jaepark611adb82016-08-17 11:34:36 -0700568 UpdateField(pField);
569}
570
Lei Zhang073ecf42018-10-11 16:56:00 +0000571void CPDFSDK_InteractiveForm::AfterCheckedStatusChange(CPDF_FormField* pField) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000572 FormFieldType fieldType = pField->GetFieldType();
573 if (fieldType != FormFieldType::kCheckBox &&
574 fieldType != FormFieldType::kRadioButton)
jaepark611adb82016-08-17 11:34:36 -0700575 return;
576
577 OnCalculate(pField);
578 UpdateField(pField);
579}
580
Lei Zhang073ecf42018-10-11 16:56:00 +0000581void CPDFSDK_InteractiveForm::AfterFormReset(CPDF_InteractiveForm* pForm) {
jaepark611adb82016-08-17 11:34:36 -0700582 OnCalculate(nullptr);
583}
584
Lei Zhang073ecf42018-10-11 16:56:00 +0000585bool CPDFSDK_InteractiveForm::IsNeedHighLight(FormFieldType fieldType) const {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000586 if (fieldType == FormFieldType::kUnknown)
tsepez4cf55152016-11-02 14:37:54 -0700587 return false;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000588
Ryan Harrison2056fac2018-01-16 16:06:45 +0000589#ifdef PDF_ENABLE_XFA
590 // For the XFA fields, we need to return if the specific field type has
591 // highlight enabled or if the general XFA field type has it enabled.
592 if (IsFormFieldTypeXFA(fieldType)) {
593 if (!m_NeedsHighlight[static_cast<size_t>(fieldType)])
594 return m_NeedsHighlight[static_cast<size_t>(FormFieldType::kXFA)];
595 }
596#endif // PDF_ENABLE_XFA
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000597 return m_NeedsHighlight[static_cast<size_t>(fieldType)];
jaepark611adb82016-08-17 11:34:36 -0700598}
599
Lei Zhang073ecf42018-10-11 16:56:00 +0000600void CPDFSDK_InteractiveForm::RemoveAllHighLights() {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000601 std::fill(m_HighlightColor, m_HighlightColor + kFormFieldTypeCount,
Lei Zhang4f7479a2018-03-21 13:37:06 +0000602 kWhiteBGR);
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000603 std::fill(m_NeedsHighlight, m_NeedsHighlight + kFormFieldTypeCount, false);
jaepark611adb82016-08-17 11:34:36 -0700604}
605
Lei Zhang073ecf42018-10-11 16:56:00 +0000606void CPDFSDK_InteractiveForm::SetHighlightColor(FX_COLORREF clr,
607 FormFieldType fieldType) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000608 if (fieldType == FormFieldType::kUnknown)
jaepark611adb82016-08-17 11:34:36 -0700609 return;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000610
611 m_HighlightColor[static_cast<size_t>(fieldType)] = clr;
612 m_NeedsHighlight[static_cast<size_t>(fieldType)] = true;
613}
614
Lei Zhang073ecf42018-10-11 16:56:00 +0000615void CPDFSDK_InteractiveForm::SetAllHighlightColors(FX_COLORREF clr) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000616 for (auto type : kFormFieldTypes) {
617 m_HighlightColor[static_cast<size_t>(type)] = clr;
618 m_NeedsHighlight[static_cast<size_t>(type)] = true;
jaepark611adb82016-08-17 11:34:36 -0700619 }
620}
621
Lei Zhang073ecf42018-10-11 16:56:00 +0000622FX_COLORREF CPDFSDK_InteractiveForm::GetHighlightColor(
623 FormFieldType fieldType) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000624 if (fieldType == FormFieldType::kUnknown)
Lei Zhang4f7479a2018-03-21 13:37:06 +0000625 return kWhiteBGR;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000626
Ryan Harrison2056fac2018-01-16 16:06:45 +0000627#ifdef PDF_ENABLE_XFA
628 // For the XFA fields, we need to return the specific field type highlight
629 // colour or the general XFA field type colour if present.
630 if (IsFormFieldTypeXFA(fieldType)) {
631 if (!m_NeedsHighlight[static_cast<size_t>(fieldType)] &&
632 m_NeedsHighlight[static_cast<size_t>(FormFieldType::kXFA)]) {
633 return m_HighlightColor[static_cast<size_t>(FormFieldType::kXFA)];
634 }
635 }
636#endif // PDF_ENABLE_XFA
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000637 return m_HighlightColor[static_cast<size_t>(fieldType)];
jaepark611adb82016-08-17 11:34:36 -0700638}