tdf#105972: pdf form: export date fields as date type

using AFDate_FormatEx which allows to set a custom format

Change-Id: I38839965423794a0278b783c39c612c361a90eea
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/134543
Tested-by: Jenkins
Reviewed-by: Xisco Fauli <xiscofauli@libreoffice.org>

6 files changed, 100 insertions, 11 deletions

diff --git a/include/vcl/pdfwriter.hxx b/include/vcl/pdfwriter.hxx
index a375cc80e2c2..ed703cc68a95 100644
--- a/include/vcl/pdfwriter.hxx
+++ b/include/vcl/pdfwriter.hxx
@@ -195,7 +195,7 @@ public:
 
     enum FormatType
     {
-        Text, Number, Time
+        Text, Number, Time, Date
     };
 
     enum ErrorCode
@@ -389,6 +389,7 @@ public:
         sal_Int32           DecimalAccuracy;
         bool                PrependCurrencySymbol;
         OUString            TimeFormat;
+        OUString            DateFormat;
 
         EditWidget()
                 : AnyWidget( vcl::PDFWriter::Edit ),
diff --git a/toolkit/source/helper/formpdfexport.cxx b/toolkit/source/helper/formpdfexport.cxx
index def4f38d8a61..1c001cd9e5c5 100644
--- a/toolkit/source/helper/formpdfexport.cxx
+++ b/toolkit/source/helper/formpdfexport.cxx
@@ -555,6 +555,54 @@ namespace toolkitform
                             }
                         }
                     } break;
+                    case FormComponentType::DATEFIELD:
+                    {
+                        pEditWidget->Format = vcl::PDFWriter::Date;
+
+                        static constexpr OUStringLiteral FM_PROP_DATEFORMAT = u"DateFormat";
+                        if ( xPSI->hasPropertyByName( FM_PROP_DATEFORMAT ) )
+                        {
+                            sal_Int32 nDateFormat = 0;
+                            if( ! (xModelProps->getPropertyValue( FM_PROP_DATEFORMAT ) >>= nDateFormat) )
+                                SAL_WARN("toolkit.helper", "describePDFControl: unable to get property " << FM_PROP_DATEFORMAT);
+
+                            switch ( nDateFormat )
+                            {
+                                case 0:
+                                case 1:
+                                    pEditWidget->DateFormat = "mm/dd/yy"; // Standard (short)
+                                    break;
+                                case 2:
+                                case 3:
+                                    pEditWidget->DateFormat = "mm/dd/yyyy"; // Standard (long)
+                                    break;
+                                case 4:
+                                    pEditWidget->DateFormat = "dd/mm/yy"; // DD/MM/YY
+                                    break;
+                                case 5:
+                                    pEditWidget->DateFormat = "mm/dd/yy"; // MM/DD/YY
+                                    break;
+                                case 6:
+                                    pEditWidget->DateFormat = "yy/mm/dd"; // YY/MM/DD
+                                    break;
+                                case 7:
+                                    pEditWidget->DateFormat = "dd/mm/yyyy"; // DD/MM/YYYY
+                                    break;
+                                case 8:
+                                    pEditWidget->DateFormat = "mm/dd/yyyy"; // MM/DD/YYYY
+                                    break;
+                                case 9:
+                                    pEditWidget->DateFormat = "yyyy/mm/dd"; // YYYY/MM/DD
+                                    break;
+                                case 10:
+                                    pEditWidget->DateFormat = "yy-mm-dd"; // YY-MM-DD
+                                    break;
+                                case 11:
+                                    pEditWidget->DateFormat = "yyyy-mm-dd"; // YYYY-MM-DD
+                                    break;
+                            }
+                        }
+                    } break;
                 }
             }
 
diff --git a/vcl/inc/pdf/pdfwriter_impl.hxx b/vcl/inc/pdf/pdfwriter_impl.hxx
index 4affbe40f24e..93889954476d 100644
--- a/vcl/inc/pdf/pdfwriter_impl.hxx
+++ b/vcl/inc/pdf/pdfwriter_impl.hxx
@@ -473,6 +473,7 @@ struct PDFWidget : public PDFAnnotation
     sal_Int32                   m_nDecimalAccuracy;
     bool                        m_bPrependCurrencySymbol;
     OUString                    m_aTimeFormat;
+    OUString                    m_aDateFormat;
     bool                        m_bSubmit;
     bool                        m_bSubmitGet;
     sal_Int32                   m_nDest;
diff --git a/vcl/qa/cppunit/pdfexport/data/tdf105972.fodt b/vcl/qa/cppunit/pdfexport/data/tdf105972.fodt
index dd8081eafde1..b9f1e29f5548 100644
--- a/vcl/qa/cppunit/pdfexport/data/tdf105972.fodt
+++ b/vcl/qa/cppunit/pdfexport/data/tdf105972.fodt
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <office:document xmlns:css3t="http://www.w3.org/TR/css3-text/" xmlns:grddl="http://www.w3.org/2003/g/data-view#" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:config="urn:oasis:names:tc:opendocument:xmlns:config:1.0" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:drawooo="http://openoffice.org/2010/draw" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:calcext="urn:org:documentfoundation:names:experimental:calc:xmlns:calcext:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:of="urn:oasis:names:tc:opendocument:xmlns:of:1.2" xmlns:tableooo="http://openoffice.org/2009/table" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:rpt="http://openoffice.org/2005/report" xmlns:formx="urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:officeooo="http://openoffice.org/2009/office" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:field="urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:loext="urn:org:documentfoundation:names:experimental:office:xmlns:loext:1.0" office:version="1.3" office:mimetype="application/vnd.oasis.opendocument.text">
- <office:meta><meta:creation-date>2022-05-17T10:53:27.044915889</meta:creation-date><dc:date>2022-05-18T10:38:21.488324901</dc:date><meta:editing-duration>PT2M19S</meta:editing-duration><meta:editing-cycles>5</meta:editing-cycles><meta:generator>LibreOfficeDev/7.4.0.0.alpha1$Linux_X86_64 LibreOffice_project/724710def53bf0a8948fcc3e83447a021aa20513</meta:generator><meta:document-statistic meta:table-count="0" meta:image-count="0" meta:object-count="0" meta:page-count="1" meta:paragraph-count="2" meta:word-count="0" meta:character-count="0" meta:non-whitespace-character-count="0"/></office:meta>
+ <office:meta><meta:creation-date>2022-05-17T10:53:27.044915889</meta:creation-date><dc:date>2022-05-18T18:02:56.717773462</dc:date><meta:editing-duration>PT3M</meta:editing-duration><meta:editing-cycles>6</meta:editing-cycles><meta:generator>LibreOfficeDev/7.4.0.0.alpha1$Linux_X86_64 LibreOffice_project/9e37c70c5c7413aee31f13fcd154cae30153e8ae</meta:generator><meta:document-statistic meta:table-count="0" meta:image-count="0" meta:object-count="0" meta:page-count="1" meta:paragraph-count="2" meta:word-count="0" meta:character-count="0" meta:non-whitespace-character-count="0"/></office:meta>
  <office:font-face-decls>
   <style:font-face style:name="Liberation Serif" svg:font-family="'Liberation Serif'" style:font-family-generic="roman" style:font-pitch="variable"/>
   <style:font-face style:name="Lohit Devanagari1" svg:font-family="'Lohit Devanagari'" style:font-family-generic="system" style:font-pitch="variable"/>
@@ -9,7 +9,7 @@
  <office:styles>
   <style:default-style style:family="graphic">
    <style:graphic-properties svg:stroke-color="#3465a4" draw:fill-color="#729fcf" fo:wrap-option="no-wrap" draw:shadow-offset-x="0.1181in" draw:shadow-offset-y="0.1181in" draw:start-line-spacing-horizontal="0.1114in" draw:start-line-spacing-vertical="0.1114in" draw:end-line-spacing-horizontal="0.1114in" draw:end-line-spacing-vertical="0.1114in" style:flow-with-text="false"/>
-   <style:paragraph-properties style:text-autospace="ideograph-alpha" style:line-break="strict" style:writing-mode="lr-tb" style:font-independent-line-spacing="false">
+   <style:paragraph-properties style:text-autospace="ideograph-alpha" style:line-break="strict" style:font-independent-line-spacing="false">
     <style:tab-stops/>
    </style:paragraph-properties>
    <style:text-properties style:use-window-font-color="true" loext:opacity="0%" loext:color-lum-mod="100%" loext:color-lum-off="0%" style:font-name="Liberation Serif" fo:font-size="12pt" fo:language="en" fo:country="US" style:letter-kerning="true" style:font-name-asian="Noto Serif CJK SC" style:font-size-asian="10.5pt" style:language-asian="zh" style:country-asian="CN" style:font-name-complex="Lohit Devanagari1" style:font-size-complex="12pt" style:language-complex="hi" style:country-complex="IN"/>
@@ -82,13 +82,13 @@
   <text:linenumbering-configuration text:number-lines="false" text:offset="0.1965in" style:num-format="1" text:number-position="left" text:increment="5"/>
  </office:styles>
  <office:automatic-styles>
-  <style:style style:name="P1" style:family="paragraph" style:parent-style-name="Standard">
-   <style:text-properties/>
+  <style:style style:name="gr1" style:family="graphic" style:data-style-name="C10048">
+   <style:graphic-properties style:wrap="run-through" style:number-wrapped-paragraphs="no-limit" style:vertical-pos="from-top" style:vertical-rel="paragraph" style:horizontal-pos="from-left" style:horizontal-rel="paragraph" draw:wrap-influence-on-position="once-concurrent" loext:allow-overlap="true" style:flow-with-text="false"/>
   </style:style>
-  <style:style style:name="gr1" style:family="graphic" style:data-style-name="C63">
+  <style:style style:name="gr2" style:family="graphic" style:data-style-name="C63">
    <style:graphic-properties style:wrap="run-through" style:number-wrapped-paragraphs="no-limit" style:vertical-pos="middle" style:vertical-rel="line" style:horizontal-pos="from-left" style:horizontal-rel="paragraph" draw:wrap-influence-on-position="once-concurrent" loext:allow-overlap="true" style:flow-with-text="false"/>
   </style:style>
-  <style:style style:name="gr2" style:family="graphic">
+  <style:style style:name="gr3" style:family="graphic">
    <style:graphic-properties style:wrap="run-through" style:number-wrapped-paragraphs="no-limit" style:vertical-pos="middle" style:vertical-rel="line" style:horizontal-pos="from-left" style:horizontal-rel="paragraph" draw:wrap-influence-on-position="once-concurrent" loext:allow-overlap="true" style:flow-with-text="false"/>
   </style:style>
   <style:page-layout style:name="pm1">
@@ -110,6 +110,13 @@
    <number:text> </number:text>
    <number:am-pm/>
   </number:time-style>
+  <number:date-style style:name="C10048" number:language="de" number:country="DE">
+   <number:year/>
+   <number:text>-</number:text>
+   <number:month number:style="long"/>
+   <number:text>-</number:text>
+   <number:day number:style="long"/>
+  </number:date-style>
  </office:automatic-styles>
  <office:master-styles>
   <style:master-page style:name="Standard" style:page-layout-name="pm1" draw:style-name="dp1"/>
@@ -142,6 +149,15 @@
        <form:property form:property-name="Text" office:value-type="string" office:string-value="11:00:00AM"/>
       </form:properties>
      </form:time>
+     <form:date form:name="DateField" form:control-implementation="ooo:com.sun.star.form.component.DateField" xml:id="control3" form:id="control3" form:current-value="2022-05-19" form:min-value="1800-01-01" form:input-required="false" form:validation="true">
+      <form:properties>
+       <form:property form:property-name="ControlTypeinMSO" office:value-type="float" office:value="0"/>
+       <form:property form:property-name="DefaultControl" office:value-type="string" office:string-value="com.sun.star.form.control.DateField"/>
+       <form:property form:property-name="MouseWheelBehavior" office:value-type="float" office:value="0"/>
+       <form:property form:property-name="ObjIDinMSO" office:value-type="float" office:value="65535"/>
+       <form:property form:property-name="Text" office:value-type="string" office:string-value="22-05-19"/>
+      </form:properties>
+     </form:date>
     </form:form>
    </office:forms>
    <text:sequence-decls>
@@ -151,9 +167,9 @@
     <text:sequence-decl text:display-outline-level="0" text:name="Drawing"/>
     <text:sequence-decl text:display-outline-level="0" text:name="Figure"/>
    </text:sequence-decls>
-   <text:p text:style-name="Standard"><draw:control text:anchor-type="as-char" draw:z-index="0" draw:name="Control 1" draw:style-name="gr2" draw:text-style-name="P3" svg:width="2.563in" svg:height="0.5732in" draw:control="control1"/></text:p>
+   <text:p text:style-name="Standard"><draw:control text:anchor-type="as-char" draw:z-index="0" draw:name="Control 1" draw:style-name="gr3" draw:text-style-name="P1" svg:width="2.563in" svg:height="0.5732in" draw:control="control1"/></text:p>
    <text:p text:style-name="Standard"/>
-   <text:p text:style-name="P1"><draw:control text:anchor-type="as-char" draw:z-index="1" draw:name="Control 2" draw:style-name="gr1" draw:text-style-name="P3" svg:width="2.4543in" svg:height="0.5732in" draw:control="control2"/></text:p>
+   <text:p text:style-name="Standard"><draw:control text:anchor-type="paragraph" draw:z-index="2" draw:name="Control 3" draw:style-name="gr1" draw:text-style-name="P1" svg:width="2.4543in" svg:height="0.5732in" svg:x="-0.0102in" svg:y="0.9374in" draw:control="control3"/><draw:control text:anchor-type="as-char" draw:z-index="1" draw:name="Control 2" draw:style-name="gr2" draw:text-style-name="P1" svg:width="2.4543in" svg:height="0.5732in" draw:control="control2"/></text:p>
   </office:text>
  </office:body>
 </office:document>
\ No newline at end of file
diff --git a/vcl/qa/cppunit/pdfexport/pdfexport.cxx b/vcl/qa/cppunit/pdfexport/pdfexport.cxx
index 6dc8f425ef67..9785bfe63732 100644
--- a/vcl/qa/cppunit/pdfexport/pdfexport.cxx
+++ b/vcl/qa/cppunit/pdfexport/pdfexport.cxx
@@ -866,7 +866,7 @@ CPPUNIT_TEST_FIXTURE(PdfExportTest, testTdf105972)
 
     auto pAnnots = dynamic_cast<vcl::filter::PDFArrayElement*>(aPages[0]->Lookup("Annots"));
     CPPUNIT_ASSERT(pAnnots);
-    CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(2), pAnnots->GetElements().size());
+    CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(3), pAnnots->GetElements().size());
 
     sal_uInt32 nTextFieldCount = 0;
     for (const auto& aElement : aDocument.GetElements())
@@ -898,7 +898,7 @@ CPPUNIT_TEST_FIXTURE(PdfExportTest, testTdf105972)
                     OString("AFNumber_Format\\(4, 0, 0, 0, \"\\\\u20ac\",true\\);"),
                     pJS->GetValue());
             }
-            else
+            else if (nTextFieldCount == 2)
             {
                 CPPUNIT_ASSERT_EQUAL(OString("TimeField"), pT->GetValue());
 
@@ -907,6 +907,15 @@ CPPUNIT_TEST_FIXTURE(PdfExportTest, testTdf105972)
                 CPPUNIT_ASSERT_EQUAL(OString("AFTime_FormatEx\\(\"h:MM:sstt\"\\);"),
                                      pJS->GetValue());
             }
+            else
+            {
+                CPPUNIT_ASSERT_EQUAL(OString("DateField"), pT->GetValue());
+
+                auto pJS
+                    = dynamic_cast<vcl::filter::PDFLiteralStringElement*>(pF->LookupElement("JS"));
+                CPPUNIT_ASSERT_EQUAL(OString("AFDate_FormatEx\\(\"yy-mm-dd\"\\);"),
+                                     pJS->GetValue());
+            }
         }
     }
 }
diff --git a/vcl/source/gdi/pdfwriter_impl.cxx b/vcl/source/gdi/pdfwriter_impl.cxx
index 7d5264af56ad..54f5a0416561 100644
--- a/vcl/source/gdi/pdfwriter_impl.cxx
+++ b/vcl/source/gdi/pdfwriter_impl.cxx
@@ -4435,6 +4435,19 @@ bool PDFWriterImpl::emitWidgetAnnotations()
                 aLine.append("/S/JavaScript>>\n");
                 aLine.append(">>\n");
             }
+            else if ( rWidget.m_nFormat == PDFWriter::Date )
+            {
+                aLine.append("/AA<<\n");
+                aLine.append("/F<</JS(AFDate_FormatEx\\(\"");
+                aLine.append(OUStringToOString(rWidget.m_aDateFormat, RTL_TEXTENCODING_ASCII_US));
+                aLine.append("\"\\);)");
+                aLine.append("/S/JavaScript>>\n");
+                aLine.append("/K<</JS(AFDate_KeystrokeEx\\(\"");
+                aLine.append(OUStringToOString(rWidget.m_aDateFormat, RTL_TEXTENCODING_ASCII_US));
+                aLine.append("\"\\);)");
+                aLine.append("/S/JavaScript>>\n");
+                aLine.append(">>\n");
+            }
         }
         if( rWidget.m_eType == PDFWriter::PushButton )
         {
@@ -11029,6 +11042,7 @@ sal_Int32 PDFWriterImpl::createControl( const PDFWriter::AnyWidget& rControl, sa
         rNewWidget.m_nDecimalAccuracy = rEdit.DecimalAccuracy;
         rNewWidget.m_bPrependCurrencySymbol = rEdit.PrependCurrencySymbol;
         rNewWidget.m_aTimeFormat = rEdit.TimeFormat;
+        rNewWidget.m_aDateFormat = rEdit.DateFormat;
         rNewWidget.m_aValue = rEdit.Text;
 
         createDefaultEditAppearance( rNewWidget, rEdit );