blob: 54ec8b4e42d37151aa14aec72c9ab68c149278c9 [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())) {
Tom Sepez3ead6722019-08-20 19:20:13 +0000118 m_pInteractiveForm->SetNotifierIface(this);
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000119 RemoveAllHighLights();
jaepark611adb82016-08-17 11:34:36 -0700120}
121
Tom Sepezc0ccf6d2019-08-16 22:04:58 +0000122CPDFSDK_InteractiveForm::~CPDFSDK_InteractiveForm() = default;
jaepark611adb82016-08-17 11:34:36 -0700123
Lei Zhang073ecf42018-10-11 16:56:00 +0000124CPDFSDK_Widget* CPDFSDK_InteractiveForm::GetWidget(
125 CPDF_FormControl* pControl) const {
Lei Zhang461acb22018-10-10 18:38:03 +0000126 if (!pControl)
jaepark611adb82016-08-17 11:34:36 -0700127 return nullptr;
128
129 CPDFSDK_Widget* pWidget = nullptr;
130 const auto it = m_Map.find(pControl);
131 if (it != m_Map.end())
132 pWidget = it->second;
133 if (pWidget)
134 return pWidget;
jaepark611adb82016-08-17 11:34:36 -0700135
136 CPDF_Dictionary* pControlDict = pControl->GetWidget();
dsinclair7cbe68e2016-10-12 11:56:23 -0700137 CPDF_Document* pDocument = m_pFormFillEnv->GetPDFDocument();
jaepark611adb82016-08-17 11:34:36 -0700138 CPDFSDK_PageView* pPage = nullptr;
139
dsinclair38fd8442016-09-15 10:15:32 -0700140 if (CPDF_Dictionary* pPageDict = pControlDict->GetDictFor("P")) {
jaepark611adb82016-08-17 11:34:36 -0700141 int nPageIndex = pDocument->GetPageIndex(pPageDict->GetObjNum());
142 if (nPageIndex >= 0)
dsinclair7cbe68e2016-10-12 11:56:23 -0700143 pPage = m_pFormFillEnv->GetPageView(nPageIndex);
jaepark611adb82016-08-17 11:34:36 -0700144 }
145
146 if (!pPage) {
147 int nPageIndex = GetPageIndexByAnnotDict(pDocument, pControlDict);
148 if (nPageIndex >= 0)
dsinclair7cbe68e2016-10-12 11:56:23 -0700149 pPage = m_pFormFillEnv->GetPageView(nPageIndex);
jaepark611adb82016-08-17 11:34:36 -0700150 }
151
Tom Sepez4ef943b2018-07-26 19:06:06 +0000152 return pPage ? ToCPDFSDKWidget(pPage->GetAnnotByDict(pControlDict)) : nullptr;
jaepark611adb82016-08-17 11:34:36 -0700153}
154
Lei Zhang073ecf42018-10-11 16:56:00 +0000155void CPDFSDK_InteractiveForm::GetWidgets(
Ryan Harrison275e2602017-09-18 14:23:18 -0400156 const WideString& sFieldName,
Tom Sepezd8ae8f82019-06-12 17:58:33 +0000157 std::vector<ObservedPtr<CPDFSDK_Annot>>* widgets) const {
Lei Zhang073ecf42018-10-11 16:56:00 +0000158 for (int i = 0, sz = m_pInteractiveForm->CountFields(sFieldName); i < sz;
159 ++i) {
160 CPDF_FormField* pFormField = m_pInteractiveForm->GetField(i, sFieldName);
jaepark611adb82016-08-17 11:34:36 -0700161 ASSERT(pFormField);
162 GetWidgets(pFormField, widgets);
163 }
164}
165
Lei Zhang073ecf42018-10-11 16:56:00 +0000166void CPDFSDK_InteractiveForm::GetWidgets(
jaepark611adb82016-08-17 11:34:36 -0700167 CPDF_FormField* pField,
Tom Sepezd8ae8f82019-06-12 17:58:33 +0000168 std::vector<ObservedPtr<CPDFSDK_Annot>>* widgets) const {
jaepark611adb82016-08-17 11:34:36 -0700169 for (int i = 0, sz = pField->CountControls(); i < sz; ++i) {
170 CPDF_FormControl* pFormCtrl = pField->GetControl(i);
171 ASSERT(pFormCtrl);
dsinclairc5267c52016-11-04 15:35:12 -0700172 CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl);
jaepark611adb82016-08-17 11:34:36 -0700173 if (pWidget)
tsepez8fa82792017-01-11 09:32:33 -0800174 widgets->emplace_back(pWidget);
jaepark611adb82016-08-17 11:34:36 -0700175 }
176}
177
Lei Zhang073ecf42018-10-11 16:56:00 +0000178int CPDFSDK_InteractiveForm::GetPageIndexByAnnotDict(
jaepark611adb82016-08-17 11:34:36 -0700179 CPDF_Document* pDocument,
180 CPDF_Dictionary* pAnnotDict) const {
181 ASSERT(pAnnotDict);
182
183 for (int i = 0, sz = pDocument->GetPageCount(); i < sz; i++) {
Tom Sepez967aa072018-05-08 13:40:20 +0000184 if (CPDF_Dictionary* pPageDict = pDocument->GetPageDictionary(i)) {
dsinclair38fd8442016-09-15 10:15:32 -0700185 if (CPDF_Array* pAnnots = pPageDict->GetArrayFor("Annots")) {
Lei Zhangf40380f2018-10-12 18:31:51 +0000186 for (int j = 0, jsz = pAnnots->size(); j < jsz; j++) {
jaepark611adb82016-08-17 11:34:36 -0700187 CPDF_Object* pDict = pAnnots->GetDirectObjectAt(j);
188 if (pAnnotDict == pDict)
189 return i;
190 }
191 }
192 }
193 }
194
195 return -1;
196}
197
Lei Zhang073ecf42018-10-11 16:56:00 +0000198void CPDFSDK_InteractiveForm::AddMap(CPDF_FormControl* pControl,
199 CPDFSDK_Widget* pWidget) {
jaepark611adb82016-08-17 11:34:36 -0700200 m_Map[pControl] = pWidget;
201}
202
Lei Zhang073ecf42018-10-11 16:56:00 +0000203void CPDFSDK_InteractiveForm::RemoveMap(CPDF_FormControl* pControl) {
jaepark611adb82016-08-17 11:34:36 -0700204 m_Map.erase(pControl);
205}
206
Lei Zhang073ecf42018-10-11 16:56:00 +0000207void CPDFSDK_InteractiveForm::EnableCalculate(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700208 m_bCalculate = bEnabled;
209}
210
Lei Zhang073ecf42018-10-11 16:56:00 +0000211bool CPDFSDK_InteractiveForm::IsCalculateEnabled() const {
jaepark611adb82016-08-17 11:34:36 -0700212 return m_bCalculate;
213}
214
215#ifdef PDF_ENABLE_XFA
Lei Zhang073ecf42018-10-11 16:56:00 +0000216void CPDFSDK_InteractiveForm::XfaEnableCalculate(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700217 m_bXfaCalculate = bEnabled;
218}
Tom Sepezc0ccf6d2019-08-16 22:04:58 +0000219
Lei Zhang073ecf42018-10-11 16:56:00 +0000220bool CPDFSDK_InteractiveForm::IsXfaCalculateEnabled() const {
jaepark611adb82016-08-17 11:34:36 -0700221 return m_bXfaCalculate;
222}
223
Lei Zhang073ecf42018-10-11 16:56:00 +0000224bool CPDFSDK_InteractiveForm::IsXfaValidationsEnabled() {
jaepark611adb82016-08-17 11:34:36 -0700225 return m_bXfaValidationsEnabled;
226}
Lei Zhang073ecf42018-10-11 16:56:00 +0000227void CPDFSDK_InteractiveForm::XfaSetValidationsEnabled(bool bEnabled) {
jaepark611adb82016-08-17 11:34:36 -0700228 m_bXfaValidationsEnabled = bEnabled;
229}
230
Lei Zhang073ecf42018-10-11 16:56:00 +0000231void CPDFSDK_InteractiveForm::SynchronizeField(CPDF_FormField* pFormField) {
jaepark611adb82016-08-17 11:34:36 -0700232 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
233 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
dsinclairc5267c52016-11-04 15:35:12 -0700234 if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl))
Dan Sinclairce047a62018-01-30 18:15:02 +0000235 pWidget->Synchronize(false);
jaepark611adb82016-08-17 11:34:36 -0700236 }
237}
238#endif // PDF_ENABLE_XFA
239
Lei Zhang073ecf42018-10-11 16:56:00 +0000240void CPDFSDK_InteractiveForm::OnCalculate(CPDF_FormField* pFormField) {
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000241 if (!m_pFormFillEnv->IsJSPlatformPresent())
jaepark611adb82016-08-17 11:34:36 -0700242 return;
243
244 if (m_bBusy)
245 return;
246
Tom Sepezc22d6712018-06-05 22:33:31 +0000247 AutoRestorer<bool> restorer(&m_bBusy);
tsepez4cf55152016-11-02 14:37:54 -0700248 m_bBusy = true;
jaepark611adb82016-08-17 11:34:36 -0700249
Tom Sepezc22d6712018-06-05 22:33:31 +0000250 if (!IsCalculateEnabled())
jaepark611adb82016-08-17 11:34:36 -0700251 return;
jaepark611adb82016-08-17 11:34:36 -0700252
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000253 IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime();
Lei Zhang073ecf42018-10-11 16:56:00 +0000254 int nSize = m_pInteractiveForm->CountFieldsInCalculationOrder();
jaepark611adb82016-08-17 11:34:36 -0700255 for (int i = 0; i < nSize; i++) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000256 CPDF_FormField* pField = m_pInteractiveForm->GetFieldInCalculationOrder(i);
jaepark611adb82016-08-17 11:34:36 -0700257 if (!pField)
258 continue;
259
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000260 FormFieldType fieldType = pField->GetFieldType();
261 if (!IsFormFieldTypeComboOrText(fieldType))
jaepark611adb82016-08-17 11:34:36 -0700262 continue;
263
264 CPDF_AAction aAction = pField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000265 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kCalculate))
jaepark611adb82016-08-17 11:34:36 -0700266 continue;
267
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000268 CPDF_Action action = aAction.GetAction(CPDF_AAction::kCalculate);
jaepark611adb82016-08-17 11:34:36 -0700269 if (!action.GetDict())
270 continue;
271
Ryan Harrison275e2602017-09-18 14:23:18 -0400272 WideString csJS = action.GetJavaScript();
jaepark611adb82016-08-17 11:34:36 -0700273 if (csJS.IsEmpty())
274 continue;
275
Ryan Harrison275e2602017-09-18 14:23:18 -0400276 WideString sOldValue = pField->GetValue();
277 WideString sValue = sOldValue;
tsepez4cf55152016-11-02 14:37:54 -0700278 bool bRC = true;
Tom Sepezc22d6712018-06-05 22:33:31 +0000279 IJS_Runtime::ScopedEventContext pContext(pRuntime);
Tom Sepez3d813152018-06-21 17:28:24 +0000280 pContext->OnField_Calculate(pFormField, pField, &sValue, &bRC);
jaepark611adb82016-08-17 11:34:36 -0700281
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000282 Optional<IJS_Runtime::JS_Error> err = pContext->RunScript(csJS);
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000283 if (!err && bRC && sValue.Compare(sOldValue) != 0)
Tom Sepezb2e6b4c2018-08-16 20:53:58 +0000284 pField->SetValue(sValue, NotificationOption::kNotify);
jaepark611adb82016-08-17 11:34:36 -0700285 }
jaepark611adb82016-08-17 11:34:36 -0700286}
287
Lei Zhang073ecf42018-10-11 16:56:00 +0000288Optional<WideString> CPDFSDK_InteractiveForm::OnFormat(
289 CPDF_FormField* pFormField) {
Lei Zhang4f261ff2018-10-10 18:44:45 +0000290 if (!m_pFormFillEnv->IsJSPlatformPresent())
291 return {};
jaepark611adb82016-08-17 11:34:36 -0700292
Lei Zhang4f261ff2018-10-10 18:44:45 +0000293 WideString sValue = pFormField->GetValue();
Tom Sepezf5ca90c2018-02-01 02:15:44 +0000294 IJS_Runtime* pRuntime = m_pFormFillEnv->GetIJSRuntime();
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000295 if (pFormField->GetFieldType() == FormFieldType::kComboBox &&
jaepark611adb82016-08-17 11:34:36 -0700296 pFormField->CountSelectedItems() > 0) {
297 int index = pFormField->GetSelectedIndex(0);
298 if (index >= 0)
299 sValue = pFormField->GetOptionLabel(index);
300 }
301
jaepark611adb82016-08-17 11:34:36 -0700302 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000303 if (aAction.GetDict() && aAction.ActionExist(CPDF_AAction::kFormat)) {
304 CPDF_Action action = aAction.GetAction(CPDF_AAction::kFormat);
jaepark611adb82016-08-17 11:34:36 -0700305 if (action.GetDict()) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400306 WideString script = action.GetJavaScript();
jaepark611adb82016-08-17 11:34:36 -0700307 if (!script.IsEmpty()) {
Tom Sepezc22d6712018-06-05 22:33:31 +0000308 IJS_Runtime::ScopedEventContext pContext(pRuntime);
Tom Sepez3ba597d2019-11-08 21:08:50 +0000309 pContext->OnField_Format(pFormField, &sValue);
Dan Sinclairdc5d88b2018-05-17 13:53:52 +0000310 Optional<IJS_Runtime::JS_Error> err = pContext->RunScript(script);
Lei Zhang4f261ff2018-10-10 18:44:45 +0000311 if (!err)
312 return sValue;
jaepark611adb82016-08-17 11:34:36 -0700313 }
314 }
315 }
Lei Zhang4f261ff2018-10-10 18:44:45 +0000316 return {};
jaepark611adb82016-08-17 11:34:36 -0700317}
318
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000319void CPDFSDK_InteractiveForm::ResetFieldAppearance(
320 CPDF_FormField* pFormField,
321 Optional<WideString> sValue) {
jaepark611adb82016-08-17 11:34:36 -0700322 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
323 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
324 ASSERT(pFormCtrl);
dsinclairc5267c52016-11-04 15:35:12 -0700325 if (CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl))
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000326 pWidget->ResetAppearance(sValue, true);
jaepark611adb82016-08-17 11:34:36 -0700327 }
328}
329
Lei Zhang073ecf42018-10-11 16:56:00 +0000330void CPDFSDK_InteractiveForm::UpdateField(CPDF_FormField* pFormField) {
Lei Zhang375c2762017-03-10 14:37:14 -0800331 auto* formfiller = m_pFormFillEnv->GetInteractiveFormFiller();
jaepark611adb82016-08-17 11:34:36 -0700332 for (int i = 0, sz = pFormField->CountControls(); i < sz; i++) {
333 CPDF_FormControl* pFormCtrl = pFormField->GetControl(i);
334 ASSERT(pFormCtrl);
335
Lei Zhang77f9bff2017-08-29 11:34:12 -0700336 CPDFSDK_Widget* pWidget = GetWidget(pFormCtrl);
337 if (!pWidget)
338 continue;
339
Tom Sepez101535f2018-06-12 13:36:05 +0000340 IPDF_Page* pPage = pWidget->GetPage();
Lei Zhang77f9bff2017-08-29 11:34:12 -0700341 FX_RECT rect = formfiller->GetViewBBox(
342 m_pFormFillEnv->GetPageView(pPage, false), pWidget);
343 m_pFormFillEnv->Invalidate(pPage, rect);
jaepark611adb82016-08-17 11:34:36 -0700344 }
345}
346
Lei Zhang073ecf42018-10-11 16:56:00 +0000347bool CPDFSDK_InteractiveForm::OnKeyStrokeCommit(CPDF_FormField* pFormField,
348 const WideString& csValue) {
jaepark611adb82016-08-17 11:34:36 -0700349 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000350 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kKeyStroke))
tsepez4cf55152016-11-02 14:37:54 -0700351 return true;
jaepark611adb82016-08-17 11:34:36 -0700352
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000353 CPDF_Action action = aAction.GetAction(CPDF_AAction::kKeyStroke);
jaepark611adb82016-08-17 11:34:36 -0700354 if (!action.GetDict())
tsepez4cf55152016-11-02 14:37:54 -0700355 return true;
jaepark611adb82016-08-17 11:34:36 -0700356
Dan Sinclair7d125322018-03-28 18:49:34 +0000357 CPDFSDK_FieldAction fa;
Lei Zhang60fa2fc2017-07-21 17:42:19 -0700358 fa.bModifier = false;
359 fa.bShift = false;
jaepark611adb82016-08-17 11:34:36 -0700360 fa.sValue = csValue;
Lei Zhang7db136a2018-10-10 21:34:17 +0000361 m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript(
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000362 action, CPDF_AAction::kKeyStroke, m_pFormFillEnv.Get(), pFormField, &fa);
jaepark611adb82016-08-17 11:34:36 -0700363 return fa.bRC;
364}
365
Lei Zhang073ecf42018-10-11 16:56:00 +0000366bool CPDFSDK_InteractiveForm::OnValidate(CPDF_FormField* pFormField,
367 const WideString& csValue) {
jaepark611adb82016-08-17 11:34:36 -0700368 CPDF_AAction aAction = pFormField->GetAdditionalAction();
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000369 if (!aAction.GetDict() || !aAction.ActionExist(CPDF_AAction::kValidate))
tsepez4cf55152016-11-02 14:37:54 -0700370 return true;
jaepark611adb82016-08-17 11:34:36 -0700371
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000372 CPDF_Action action = aAction.GetAction(CPDF_AAction::kValidate);
jaepark611adb82016-08-17 11:34:36 -0700373 if (!action.GetDict())
tsepez4cf55152016-11-02 14:37:54 -0700374 return true;
jaepark611adb82016-08-17 11:34:36 -0700375
Dan Sinclair7d125322018-03-28 18:49:34 +0000376 CPDFSDK_FieldAction fa;
Lei Zhang60fa2fc2017-07-21 17:42:19 -0700377 fa.bModifier = false;
378 fa.bShift = false;
jaepark611adb82016-08-17 11:34:36 -0700379 fa.sValue = csValue;
Lei Zhang7db136a2018-10-10 21:34:17 +0000380 m_pFormFillEnv->GetActionHandler()->DoAction_FieldJavaScript(
Hans Wennborgc320e9c2018-10-22 18:28:52 +0000381 action, CPDF_AAction::kValidate, m_pFormFillEnv.Get(), pFormField, &fa);
jaepark611adb82016-08-17 11:34:36 -0700382 return fa.bRC;
383}
384
Lei Zhang073ecf42018-10-11 16:56:00 +0000385bool CPDFSDK_InteractiveForm::DoAction_Hide(const CPDF_Action& action) {
jaepark611adb82016-08-17 11:34:36 -0700386 ASSERT(action.GetDict());
387
388 CPDF_ActionFields af(&action);
Lei Zhang5cee3f22018-05-25 21:48:49 +0000389 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700390 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
391
392 bool bHide = action.GetHideStatus();
tsepez4cf55152016-11-02 14:37:54 -0700393 bool bChanged = false;
jaepark611adb82016-08-17 11:34:36 -0700394
395 for (CPDF_FormField* pField : fields) {
396 for (int i = 0, sz = pField->CountControls(); i < sz; ++i) {
397 CPDF_FormControl* pControl = pField->GetControl(i);
398 ASSERT(pControl);
399
dsinclairc5267c52016-11-04 15:35:12 -0700400 if (CPDFSDK_Widget* pWidget = GetWidget(pControl)) {
jaepark611adb82016-08-17 11:34:36 -0700401 uint32_t nFlags = pWidget->GetFlags();
Lei Zhang85549b42019-02-02 00:40:19 +0000402 nFlags &= ~pdfium::annotation_flags::kInvisible;
403 nFlags &= ~pdfium::annotation_flags::kNoView;
jaepark611adb82016-08-17 11:34:36 -0700404 if (bHide)
Lei Zhang85549b42019-02-02 00:40:19 +0000405 nFlags |= pdfium::annotation_flags::kHidden;
jaepark611adb82016-08-17 11:34:36 -0700406 else
Lei Zhang85549b42019-02-02 00:40:19 +0000407 nFlags &= ~pdfium::annotation_flags::kHidden;
jaepark611adb82016-08-17 11:34:36 -0700408 pWidget->SetFlags(nFlags);
409 pWidget->GetPageView()->UpdateView(pWidget);
tsepez4cf55152016-11-02 14:37:54 -0700410 bChanged = true;
jaepark611adb82016-08-17 11:34:36 -0700411 }
412 }
413 }
414
415 return bChanged;
416}
417
Lei Zhang073ecf42018-10-11 16:56:00 +0000418bool CPDFSDK_InteractiveForm::DoAction_SubmitForm(const CPDF_Action& action) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400419 WideString sDestination = action.GetFilePath();
jaepark611adb82016-08-17 11:34:36 -0700420 if (sDestination.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700421 return false;
jaepark611adb82016-08-17 11:34:36 -0700422
Lei Zhang5cee3f22018-05-25 21:48:49 +0000423 const CPDF_Dictionary* pActionDict = action.GetDict();
jaepark611adb82016-08-17 11:34:36 -0700424 if (pActionDict->KeyExist("Fields")) {
425 CPDF_ActionFields af(&action);
426 uint32_t dwFlags = action.GetFlags();
Lei Zhang5cee3f22018-05-25 21:48:49 +0000427 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700428 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
429 if (!fields.empty()) {
430 bool bIncludeOrExclude = !(dwFlags & 0x01);
Lei Zhang073ecf42018-10-11 16:56:00 +0000431 if (!m_pInteractiveForm->CheckRequiredFields(&fields, bIncludeOrExclude))
tsepez4cf55152016-11-02 14:37:54 -0700432 return false;
jaepark611adb82016-08-17 11:34:36 -0700433
434 return SubmitFields(sDestination, fields, bIncludeOrExclude, false);
435 }
436 }
Lei Zhang073ecf42018-10-11 16:56:00 +0000437 if (!m_pInteractiveForm->CheckRequiredFields(nullptr, true))
tsepez4cf55152016-11-02 14:37:54 -0700438 return false;
jaepark611adb82016-08-17 11:34:36 -0700439
tsepez4cf55152016-11-02 14:37:54 -0700440 return SubmitForm(sDestination, false);
jaepark611adb82016-08-17 11:34:36 -0700441}
442
Lei Zhang073ecf42018-10-11 16:56:00 +0000443bool CPDFSDK_InteractiveForm::SubmitFields(
444 const WideString& csDestination,
445 const std::vector<CPDF_FormField*>& fields,
446 bool bIncludeOrExclude,
447 bool bUrlEncoded) {
Ryan Harrison275e2602017-09-18 14:23:18 -0400448 ByteString textBuf = ExportFieldsToFDFTextBuf(fields, bIncludeOrExclude);
Tom Sepez65be34f2018-09-14 20:58:36 +0000449 if (textBuf.IsEmpty())
Henrique Nakashimaaea80dc2017-08-01 19:47:24 -0400450 return false;
Henrique Nakashimaaea80dc2017-08-01 19:47:24 -0400451
Tom Sepez65be34f2018-09-14 20:58:36 +0000452 std::vector<uint8_t> buffer(textBuf.begin(), textBuf.end());
Lei Zhang2ee811f2018-08-13 21:32:50 +0000453 if (bUrlEncoded && !FDFToURLEncodedData(&buffer))
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400454 return false;
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400455
Tom Sepeze9703972019-08-09 21:24:29 +0000456 m_pFormFillEnv->SubmitForm(buffer, csDestination);
tsepez4cf55152016-11-02 14:37:54 -0700457 return true;
jaepark611adb82016-08-17 11:34:36 -0700458}
459
Lei Zhang073ecf42018-10-11 16:56:00 +0000460ByteString CPDFSDK_InteractiveForm::ExportFieldsToFDFTextBuf(
jaepark611adb82016-08-17 11:34:36 -0700461 const std::vector<CPDF_FormField*>& fields,
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400462 bool bIncludeOrExclude) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000463 std::unique_ptr<CFDF_Document> pFDF = m_pInteractiveForm->ExportToFDF(
Tom Sepeze9703972019-08-09 21:24:29 +0000464 m_pFormFillEnv->GetFilePath(), fields, bIncludeOrExclude, false);
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400465
Ryan Harrison275e2602017-09-18 14:23:18 -0400466 return pFDF ? pFDF->WriteToString() : ByteString();
jaepark611adb82016-08-17 11:34:36 -0700467}
468
Lei Zhang073ecf42018-10-11 16:56:00 +0000469bool CPDFSDK_InteractiveForm::SubmitForm(const WideString& sDestination,
470 bool bUrlEncoded) {
jaepark611adb82016-08-17 11:34:36 -0700471 if (sDestination.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700472 return false;
jaepark611adb82016-08-17 11:34:36 -0700473
Tom Sepeze9703972019-08-09 21:24:29 +0000474 std::unique_ptr<CFDF_Document> pFDFDoc =
475 m_pInteractiveForm->ExportToFDF(m_pFormFillEnv->GetFilePath(), false);
jaepark611adb82016-08-17 11:34:36 -0700476 if (!pFDFDoc)
tsepez4cf55152016-11-02 14:37:54 -0700477 return false;
jaepark611adb82016-08-17 11:34:36 -0700478
Ryan Harrison275e2602017-09-18 14:23:18 -0400479 ByteString fdfBuffer = pFDFDoc->WriteToString();
Ryan Harrison875e98c2017-09-27 10:53:11 -0400480 if (fdfBuffer.IsEmpty())
tsepez4cf55152016-11-02 14:37:54 -0700481 return false;
jaepark611adb82016-08-17 11:34:36 -0700482
Tom Sepez65be34f2018-09-14 20:58:36 +0000483 std::vector<uint8_t> buffer(fdfBuffer.begin(), fdfBuffer.end());
Lei Zhang2ee811f2018-08-13 21:32:50 +0000484 if (bUrlEncoded && !FDFToURLEncodedData(&buffer))
tsepez4cf55152016-11-02 14:37:54 -0700485 return false;
jaepark611adb82016-08-17 11:34:36 -0700486
Tom Sepeze9703972019-08-09 21:24:29 +0000487 m_pFormFillEnv->SubmitForm(buffer, sDestination);
tsepez4cf55152016-11-02 14:37:54 -0700488 return true;
jaepark611adb82016-08-17 11:34:36 -0700489}
490
Lei Zhang073ecf42018-10-11 16:56:00 +0000491ByteString CPDFSDK_InteractiveForm::ExportFormToFDFTextBuf() {
Tom Sepeze9703972019-08-09 21:24:29 +0000492 std::unique_ptr<CFDF_Document> pFDF =
493 m_pInteractiveForm->ExportToFDF(m_pFormFillEnv->GetFilePath(), false);
Henrique Nakashima5c09f4c2017-08-04 12:28:52 -0400494
Ryan Harrison275e2602017-09-18 14:23:18 -0400495 return pFDF ? pFDF->WriteToString() : ByteString();
jaepark611adb82016-08-17 11:34:36 -0700496}
497
Lei Zhang073ecf42018-10-11 16:56:00 +0000498void CPDFSDK_InteractiveForm::DoAction_ResetForm(const CPDF_Action& action) {
jaepark611adb82016-08-17 11:34:36 -0700499 ASSERT(action.GetDict());
Lei Zhang5cee3f22018-05-25 21:48:49 +0000500 const CPDF_Dictionary* pActionDict = action.GetDict();
dan sinclair7544a4b2018-03-08 15:19:50 +0000501 if (!pActionDict->KeyExist("Fields")) {
Lei Zhang073ecf42018-10-11 16:56:00 +0000502 m_pInteractiveForm->ResetForm(NotificationOption::kNotify);
dan sinclair7544a4b2018-03-08 15:19:50 +0000503 return;
504 }
jaepark611adb82016-08-17 11:34:36 -0700505 CPDF_ActionFields af(&action);
506 uint32_t dwFlags = action.GetFlags();
Lei Zhang5cee3f22018-05-25 21:48:49 +0000507 std::vector<const CPDF_Object*> fieldObjects = af.GetAllFields();
jaepark611adb82016-08-17 11:34:36 -0700508 std::vector<CPDF_FormField*> fields = GetFieldFromObjects(fieldObjects);
Lei Zhang073ecf42018-10-11 16:56:00 +0000509 m_pInteractiveForm->ResetForm(fields, !(dwFlags & 0x01),
510 NotificationOption::kNotify);
jaepark611adb82016-08-17 11:34:36 -0700511}
512
Lei Zhang073ecf42018-10-11 16:56:00 +0000513std::vector<CPDF_FormField*> CPDFSDK_InteractiveForm::GetFieldFromObjects(
Lei Zhang5cee3f22018-05-25 21:48:49 +0000514 const std::vector<const CPDF_Object*>& objects) const {
jaepark611adb82016-08-17 11:34:36 -0700515 std::vector<CPDF_FormField*> fields;
Lei Zhang5cee3f22018-05-25 21:48:49 +0000516 for (const CPDF_Object* pObject : objects) {
Dan Sinclairce047a62018-01-30 18:15:02 +0000517 if (!pObject || !pObject->IsString())
518 continue;
519
520 WideString csName = pObject->GetUnicodeText();
Lei Zhang073ecf42018-10-11 16:56:00 +0000521 CPDF_FormField* pField = m_pInteractiveForm->GetField(0, csName);
Dan Sinclairce047a62018-01-30 18:15:02 +0000522 if (pField)
523 fields.push_back(pField);
jaepark611adb82016-08-17 11:34:36 -0700524 }
525 return fields;
526}
527
Lei Zhang073ecf42018-10-11 16:56:00 +0000528bool CPDFSDK_InteractiveForm::BeforeValueChange(CPDF_FormField* pField,
529 const WideString& csValue) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000530 FormFieldType fieldType = pField->GetFieldType();
531 if (!IsFormFieldTypeComboOrText(fieldType))
dan sinclair507fb4e2018-03-08 15:14:09 +0000532 return true;
jaepark611adb82016-08-17 11:34:36 -0700533 if (!OnKeyStrokeCommit(pField, csValue))
dan sinclair507fb4e2018-03-08 15:14:09 +0000534 return false;
535 return OnValidate(pField, csValue);
jaepark611adb82016-08-17 11:34:36 -0700536}
537
Lei Zhang073ecf42018-10-11 16:56:00 +0000538void CPDFSDK_InteractiveForm::AfterValueChange(CPDF_FormField* pField) {
jaepark611adb82016-08-17 11:34:36 -0700539#ifdef PDF_ENABLE_XFA
Dan Sinclairce047a62018-01-30 18:15:02 +0000540 SynchronizeField(pField);
jaepark611adb82016-08-17 11:34:36 -0700541#endif // PDF_ENABLE_XFA
Dan Sinclairce047a62018-01-30 18:15:02 +0000542
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000543 FormFieldType fieldType = pField->GetFieldType();
Dan Sinclairce047a62018-01-30 18:15:02 +0000544 if (!IsFormFieldTypeComboOrText(fieldType))
545 return;
546
547 OnCalculate(pField);
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000548 ResetFieldAppearance(pField, OnFormat(pField));
Dan Sinclairce047a62018-01-30 18:15:02 +0000549 UpdateField(pField);
jaepark611adb82016-08-17 11:34:36 -0700550}
551
Lei Zhang073ecf42018-10-11 16:56:00 +0000552bool CPDFSDK_InteractiveForm::BeforeSelectionChange(CPDF_FormField* pField,
553 const WideString& csValue) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000554 if (pField->GetFieldType() != FormFieldType::kListBox)
dan sinclair507fb4e2018-03-08 15:14:09 +0000555 return true;
jaepark611adb82016-08-17 11:34:36 -0700556 if (!OnKeyStrokeCommit(pField, csValue))
dan sinclair507fb4e2018-03-08 15:14:09 +0000557 return false;
558 return OnValidate(pField, csValue);
jaepark611adb82016-08-17 11:34:36 -0700559}
560
Lei Zhang073ecf42018-10-11 16:56:00 +0000561void CPDFSDK_InteractiveForm::AfterSelectionChange(CPDF_FormField* pField) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000562 if (pField->GetFieldType() != FormFieldType::kListBox)
jaepark611adb82016-08-17 11:34:36 -0700563 return;
564
565 OnCalculate(pField);
Lei Zhang3b37f6b2019-07-29 23:31:26 +0000566 ResetFieldAppearance(pField, pdfium::nullopt);
jaepark611adb82016-08-17 11:34:36 -0700567 UpdateField(pField);
568}
569
Lei Zhang073ecf42018-10-11 16:56:00 +0000570void CPDFSDK_InteractiveForm::AfterCheckedStatusChange(CPDF_FormField* pField) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000571 FormFieldType fieldType = pField->GetFieldType();
572 if (fieldType != FormFieldType::kCheckBox &&
573 fieldType != FormFieldType::kRadioButton)
jaepark611adb82016-08-17 11:34:36 -0700574 return;
575
576 OnCalculate(pField);
577 UpdateField(pField);
578}
579
Lei Zhang073ecf42018-10-11 16:56:00 +0000580void CPDFSDK_InteractiveForm::AfterFormReset(CPDF_InteractiveForm* pForm) {
jaepark611adb82016-08-17 11:34:36 -0700581 OnCalculate(nullptr);
582}
583
Lei Zhang073ecf42018-10-11 16:56:00 +0000584bool CPDFSDK_InteractiveForm::IsNeedHighLight(FormFieldType fieldType) const {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000585 if (fieldType == FormFieldType::kUnknown)
tsepez4cf55152016-11-02 14:37:54 -0700586 return false;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000587
Ryan Harrison2056fac2018-01-16 16:06:45 +0000588#ifdef PDF_ENABLE_XFA
589 // For the XFA fields, we need to return if the specific field type has
590 // highlight enabled or if the general XFA field type has it enabled.
591 if (IsFormFieldTypeXFA(fieldType)) {
592 if (!m_NeedsHighlight[static_cast<size_t>(fieldType)])
593 return m_NeedsHighlight[static_cast<size_t>(FormFieldType::kXFA)];
594 }
595#endif // PDF_ENABLE_XFA
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000596 return m_NeedsHighlight[static_cast<size_t>(fieldType)];
jaepark611adb82016-08-17 11:34:36 -0700597}
598
Lei Zhang073ecf42018-10-11 16:56:00 +0000599void CPDFSDK_InteractiveForm::RemoveAllHighLights() {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000600 std::fill(m_HighlightColor, m_HighlightColor + kFormFieldTypeCount,
Lei Zhang4f7479a2018-03-21 13:37:06 +0000601 kWhiteBGR);
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000602 std::fill(m_NeedsHighlight, m_NeedsHighlight + kFormFieldTypeCount, false);
jaepark611adb82016-08-17 11:34:36 -0700603}
604
Lei Zhang073ecf42018-10-11 16:56:00 +0000605void CPDFSDK_InteractiveForm::SetHighlightColor(FX_COLORREF clr,
606 FormFieldType fieldType) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000607 if (fieldType == FormFieldType::kUnknown)
jaepark611adb82016-08-17 11:34:36 -0700608 return;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000609
610 m_HighlightColor[static_cast<size_t>(fieldType)] = clr;
611 m_NeedsHighlight[static_cast<size_t>(fieldType)] = true;
612}
613
Lei Zhang073ecf42018-10-11 16:56:00 +0000614void CPDFSDK_InteractiveForm::SetAllHighlightColors(FX_COLORREF clr) {
Lei Zhangea5411d2019-12-13 17:39:48 +0000615 for (size_t i = 0; i < kFormFieldTypeCount; ++i) {
616 m_HighlightColor[i] = clr;
617 m_NeedsHighlight[i] = true;
jaepark611adb82016-08-17 11:34:36 -0700618 }
619}
620
Lei Zhang073ecf42018-10-11 16:56:00 +0000621FX_COLORREF CPDFSDK_InteractiveForm::GetHighlightColor(
622 FormFieldType fieldType) {
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000623 if (fieldType == FormFieldType::kUnknown)
Lei Zhang4f7479a2018-03-21 13:37:06 +0000624 return kWhiteBGR;
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000625
Ryan Harrison2056fac2018-01-16 16:06:45 +0000626#ifdef PDF_ENABLE_XFA
627 // For the XFA fields, we need to return the specific field type highlight
628 // colour or the general XFA field type colour if present.
629 if (IsFormFieldTypeXFA(fieldType)) {
630 if (!m_NeedsHighlight[static_cast<size_t>(fieldType)] &&
631 m_NeedsHighlight[static_cast<size_t>(FormFieldType::kXFA)]) {
632 return m_HighlightColor[static_cast<size_t>(FormFieldType::kXFA)];
633 }
634 }
635#endif // PDF_ENABLE_XFA
Ryan Harrison9baf31f2018-01-12 18:36:30 +0000636 return m_HighlightColor[static_cast<size_t>(fieldType)];
jaepark611adb82016-08-17 11:34:36 -0700637}