[RELEASE] iText 7 Core - 7.1.12

https://github.com/itext/itext7/releases/tag/7.1.12

* release/7.1.12:
  [RELEASE] 7.1.12-SNAPSHOT -> 7.1.12
  Remove outdated TODOs in TableRenderer
  Fix ClipperBridge javadoc warnings
  Register pdfOcr events on kernel level. Treat inner namespaces in ContextManager correctly
  Remove TODOs in Lab and IccBased colors
  Add check for pdf names in pdfa
  Enable khmer and lao word wrapping
  Add missed doc for exceptions in xmp package
  Add color spots number check
  Set zero or negative size log message level to INFO for drawBackground method
  Fix javadoc warnings
  Deprecate svg node renderer mapper interface
  Fix javadoc for TIFFDirectory and TIFFField
  Add check for number values in pdfa module
  Add tests for table elements with HorizontalAlignment
  Add runProcessAndWait method overload and coresponding unit test
  Update message formatting in SvgConverterIntegrationTest
  Add check for length of arrays and dictionaries
  Add check for String lengths in PDFA module
  Remove ToDo in PdfA1GraphicsTest#transparencyCheckTest1()
  Add HEIGHT constant to CssDefaults
  Remove TODO from isiText5licenseLoaded method
  Add missing copyright headers
  Add calculating path and text bounding box in SVG
  Add tests for applying SVG linear gradient to different types of path elements
  Add PdfDocument as an argument for build linear gradient
  Add new PdfStreamTest class, new PdfStructTreeRootTest#severalSameElementsInStructTreeRootTest
  Fix several kernel/pdf/canvas javadoc warnings
  Add missing copyright headers
  Fix NullPointerException in AbstractRenderer class and update createXObject method
  Add missing copyright headers
  Add shorthand text decoration support
  Add convenience methods to increase and decrease widths of rectangle in chain
  Attach JIRA ticket to TODO in SvgConverterUnitTest
  Linear Gradient update to handle pad properly, Css gradient parsing fix, tests updates
  Fix problem with desc coordinates domain for gradient
  Add linear gradient support to ListStyleShorthandResolver class
  Add ticket references to TODO remarks
  Add missing copyright headers
  Special scripts word wrapping support
  Fix BUILDING.MD
  Add background image support for text elements for layout module
  Add test on bug with one coordinate in <tspan>
  Add SXP linear-gradient tests
  Improve several kernel/pdf javadocs
  Improve several kernel JavaDocs
  Add missing javadocs
  Fix PdfFileSpec javadoc warnings
  Add private constгuctor to PdfCanvasConstants to prevent instantation
  Add missing copyright headers
  Linear gradient logic
  Add test on marker parent issue
  Add check of marker x,y attributes
  Add test on resolving styles with relative units
  Change in Jenkinsfile to abort possible already running automatic builds
  Improve several javadocs in kernel module
  Fix javadoc for PdfWriter and ReaderProperties
  Add javadoc for thrown exceptions in CompareTool
  Add explicit cast
  Add resourcesCategoryDictionarySetModifiedTest and add minor improvements
  Fixing issue with font embedding in append mode
  Add ticket references to TODO-s
  Remove recordIssues from Jenkinsfile
  Update notice file
  Fix javadoc warnings
  Add missing copyright headers
  Move WeirdCharactersTest from html2pdf
  Add exception if no previous shape for smooth curve specified
  Fix ptoblem with entries in cross-reference stream
  Adjust some tests in SvgStyleResolverIntegrationTest
  Update .mailmap
  Fix several iTextCore javadoc issues
  Add check if order key presented to PDFA2 and PDFA3 validation
  Fix PdfViewerPreferences javadoc issues
  Add tests for kernel.pdf.collection package
  Add ticket references to toDo remarks
  Update ToDo remarks in TextSvgBranchRenderer
  Update CompareTool and fix float precision issues
  Add missing copyright headers
  Fix JavaDoc for pdf annotation classes
  Improve Style documentation and tests
  Remove ToDo
  Remove ToDo
  Remove obsolete toDo remark
  Fix an issue with splitRenderer having less content than needed when the result is NOTHING
  Add missing copyright headers
  Add new Pdf20SigningTest#signExistingFieldWhenDirectAcroformAndNoSigFlagTest
  Remove clirr-maven-plugin
  Fix division by zero
  Add preserveAspectRatio support for images
  Delete TODO about pseudo-elements in SVG
  Minor Javadoc fix
  Remove obsolete toDo remark
  Add ticket references to toDos
  Always copy link annotation on draw
  Remove an unused cmp file
  Remove obsolete todo
  Add new tests for creating entries for xref stream
  Update ToDo remark in BackgroundShorthandResolver
  Disallow removing flushed pages for tagged documents or documents with acroforms
  Log warnings in case we need to reset "full compression" setting in append mode
  Move, refactor merge tests from samples internal repository
  Add deprecated tag to TextRenderer JavaDoc
  Fix problem with numerous replaceSpecialWhitespaceGlyhs method calls
  Add test for not fitted footer in large table
  Document TableBorder's fields
  Introduce dedicated tests for axial and radial shadings
  Add missing copyright headers
  Add tests to improve code coverage
  Don't move the whole element to the next area in case its first children cannot be kept together
  Remove ToDo remark in PdfFormField#drawPdfA1CheckAppearance
  Fix large table split
  Add DEVSIX within todo remark
  Change comment
  Delete duplicate test
  Fix bug with text vertical alignment in choice fields
  Improve imagemagick constants
  Add DocumentSerializationTest class
  Optimize replaceSpecialWhitespaceGlyphs method
  Make image type validation more concise
  Deprecate unneeded size field in BmpImageData and associated constructors/creators
  Improve coverage on existing code
  Introduce ImageTypeDetector class for detecting image types from magic bytes
  Add missing copyright headers
  Add some TODO remarks related to COLLAPSING_MARGINS + KEEP_TOGETHER processing
  Introduce RootRendererStateHandler to process going back and forward.
  Improve tagging and processing of flushed waiting elements. Refactor storing mechanism
  Add tests which shows that floats work incorectly with KEEP_TOGETHER
  Improve ReplaceSpecialWhitespaceGlyphs method performance
  Discard builds depending on the branch in the Jenkinsfile
  Add new test to increase code coverage
  Add possibility to remove outlines in public API
  Update ToDo remarks in styled-xml-parser module
  Fix bug with glyph width for PdfType3Font
  Resolve RND todo remarks
  Remove obsolete TODOs
  Improve TIFFLZWDecoder JavaDoc
  Update TODO in svg
  Improve documentation for Path class
  Add missing copyright headers
  Add TextPreprocessingUtil class and unit test
  Add new tests
  Add JPXDecode image extracting test
  Improve LocationTextExtractionStrategyTest so that it could be ported automatically
  Reuse the same instance of ResourceResolver in SVG processing
  Update ToDo remarks
  Delete TODO
  Update TODOs in tests about overflow caused by margin/padding/borders
  Remove TODO-leftovers. Update TODOs with obsolete ticket IDs
  Add DEVSIX to a TODO
  Refactor tests after fix, remove Todo remarks
  Add several unicodes one glyph test
  Fix a bunch of javadoc errors in XFDF module
  Review TODOs in svg/src/main/java/com/itextpdf/svg/css/impl
  Use nightly updated NVD database for dependency-check-maven
  Fix a bunch of Javadoc warnings in io module
  Refactoring: remove redundant entries from pom files
  Move pitest to its own profile
  Move ImageTest from samples internal repository
  Remove obsolete TODO
  Add DR font tests from samples internal repository
  Add a TODO to indicate in the code known font-family parsing issue
  Added test and todos for constants
  Fix layout-related javadoc warnings
  Fix PdfReader javadoc errors
  Fix modifing direct acroform in append mode
  Tests for big stroke for circle and ellipse in svg
  Add several new tests
  Add FreeReferencesTest#readingXrefWithLotsOfFreeObjTest
  Add InheritedPageEntriesTest#copySeveralPagesToDocumentWithInheritedPageRotationTest
  [RELEASE] Update dependency versions
  Revert 'protected' FontSelectorStrategy#tempFonts field renaming
  Add missing copyright headers
  Remove unused svg.TestUtil class
  Refactor tests in DefsSvgNodeRendererUnitTest class
  Add missing copyright headers
  Add XrefStreamIncrementalUpdatesReadingTest#freeRefReusingInAppendModeTest

Author: iText-CI

.mailmap

@@ -64,7 +64,6 @@ Peter Goodman <[email protected]>                              <[email protected]
 Peter Goodman <[email protected]>                              <[email protected]>
 Peter Goodman <[email protected]>                              <[email protected]>
 Peter Kjuak <[email protected]>                        <[email protected]>
-Richard Cohn <[email protected]>                                <[email protected]>
 Richard Schwark <[email protected]>                   <[email protected]>
 Roman Leonov <[email protected]>                       <[email protected]>
 Roman Nadvodny <[email protected]>                 <[email protected]>

BUILDING.md

@@ -7,12 +7,28 @@ $ mvn clean install \
     > >(tee mvn.log) 2> >(tee mvn-error.log >&2)
 ```
 
-To run the tests, [Ghostscript][2] and [Imagemagick][3] must be installed.
+Please note that tests are not run in default profile. To run tests, [Ghostscript][2] and [Imagemagick][3] must be installed. 
+Some of the tests compare generated PDF files with template files that show the correct results, and these tools are used to
+visually compare PDF files. Ghostscript is required to render PDF files into images and Imagemagick is used to compare image data. 
+There are two options for running tests:
+1. Pass Ghostscript and Imagemagick compare commands as ITEXT_GS_EXEC and ITEXT_MAGICK_COMPARE_EXEC environment variables, respectively 
+(Ghostscript and Imagemagick folders must be added to PATH environment variable). This option is suitable for both Windows and Unix systems. 
+The syntax of commands depends on installed Ghostscript and Imagemagick versions (`gs`, `gswin64c`, `magick compare`).
+2. Pass the paths to Ghostscript and Imagemagick compare execution files as ITEXT_GS_EXEC and ITEXT_MAGICK_COMPARE_EXEC 
+environment variables. Examples of paths on Windows:
+- `C:\Program Files\gs\gs9.26\bin\gswin64c.exe`
+- `C:\Program Files\ImageMagick-7.0.9-Q16\compare.exe`
+
+If you have a new version of ImageMagick, then there is no compare.exe utility there, wrap the path to magick.exe in quotes and call compare command:
+ITEXT_MAGICK_COMPARE_EXEC=`"C:\Program Files\ImageMagick-7.0.9-Q16\magick.exe" compare`
+
+To run build with tests, activate the `test` profile and pass ITEXT_GS_EXEC and ITEXT_MAGICK_COMPARE_EXEC environment variables:
 ```bash
 $ mvn clean install \
+	-P test \
     -Dmaven.test.failure.ignore=false \
-    -DgsExec=$(which gs) \
-    -DcompareExec=$(which compare) \
+    -DITEXT_GS_EXEC="gs command" \
+    -DITEXT_MAGICK_COMPARE_EXEC="magick compare command" \
     > >(tee mvn.log) 2> >(tee mvn-error.log >&2)
 ```
 

Jenkinsfile

@@ -1,24 +1,7 @@
 #!/usr/bin/env groovy
 @Library('pipeline-library')_
 
-def schedule, sonarBranchName, sonarBranchTarget
-switch (env.BRANCH_NAME) {
-    case ~/.*master.*/:
-        schedule = '@monthly'
-        sonarBranchName = '-Dsonar.branch.name=master'
-        sonarBranchTarget = ''
-        break
-    case ~/.*develop.*/:
-        schedule = '@midnight'
-        sonarBranchName = '-Dsonar.branch.name=develop'
-        sonarBranchTarget = '-Dsonar.branch.target=master'
-        break
-    default:
-        schedule = ''
-        sonarBranchName = '-Dsonar.branch.name=' + env.BRANCH_NAME
-        sonarBranchTarget = '-Dsonar.branch.target=develop'
-        break
-}
+def vars = setBranchDependentVars(env.BRANCH_NAME)
 
 pipeline {
 
@@ -30,15 +13,22 @@ pipeline {
 
     options {
         ansiColor('xterm')
-        buildDiscarder(logRotator(artifactNumToKeepStr: '1'))
+        buildDiscarder(
+            logRotator(
+                numToKeepStr: vars.buildNumToKeep,
+                artifactNumToKeepStr: vars.buildArtifactNumToKeep,
+                daysToKeepStr: vars.buildDaysToKeep,
+                artifactDaysToKeepStr: vars.buildArtifactDaysToKeep
+            )
+        )
         parallelsAlwaysFailFast()
         skipStagesAfterUnstable()
         timeout(time: 2, unit: 'HOURS')
         timestamps()
     }
 
     triggers {
-        cron(schedule)
+        cron(vars.schedule)
     }
 
     tools {
@@ -47,6 +37,13 @@ pipeline {
     }
 
     stages {
+	    stage('Abort possible previous builds') {
+            steps {
+                script {
+                    abortPreviousBuilds()
+                }
+            }
+        }
         stage('Build') {
             options {
                 retry(2)
@@ -90,11 +87,6 @@ pipeline {
                 withMaven(jdk: "${JDK_VERSION}", maven: 'M3', mavenLocalRepo: '.repository') {
                     sh 'mvn --no-transfer-progress verify --activate-profiles qa -Dpmd.analysisCache=true'
                 }
-                recordIssues(tools: [
-                        checkStyle(),
-                        pmdParser(),
-                        spotBugs(useRankAsPriority: true)
-                ])
                 dependencyCheckPublisher pattern: 'target/dependency-check-report.xml'
             }
         }
@@ -105,7 +97,7 @@ pipeline {
             steps {
                 withMaven(jdk: "${JDK_VERSION}", maven: 'M3', mavenLocalRepo: '.repository') {
                     withSonarQubeEnv('Sonar') {
-                        sh 'mvn --no-transfer-progress --activate-profiles test -DgsExec="${gsExec}" -DcompareExec="${compareExec}" -Dmaven.main.skip=true -Dmaven.test.failure.ignore=false org.jacoco:jacoco-maven-plugin:prepare-agent verify org.jacoco:jacoco-maven-plugin:report -Dsonar.java.spotbugs.reportPaths="target/spotbugs.xml" sonar:sonar ' + sonarBranchName + ' ' + sonarBranchTarget
+                        sh "mvn --no-transfer-progress --activate-profiles test -DgsExec=\"$gsExec\" -DcompareExec=\"$compareExec\" -Dmaven.main.skip=true -Dmaven.test.failure.ignore=false org.jacoco:jacoco-maven-plugin:prepare-agent verify org.jacoco:jacoco-maven-plugin:report -Dsonar.java.spotbugs.reportPaths=\"target/spotbugs.xml\" sonar:sonar $vars.sonarBranchName $vars.sonarBranchTarget"
                     }
                 }
             }
@@ -198,14 +190,14 @@ pipeline {
         }
         fixed {
             script {
-                if (env.BRANCH_NAME.contains('master') || env.BRANCH_NAME.contains('develop')) {
+                if (vars.notifySlack) {
                     slackNotifier("#ci", currentBuild.currentResult, "${env.BRANCH_NAME} - Back to normal")
                 }
             }
         }
         regression {
             script {
-                if (env.BRANCH_NAME.contains('master') || env.BRANCH_NAME.contains('develop')) {
+                if (vars.notifySlack) {
                     slackNotifier("#ci", currentBuild.currentResult, "${env.BRANCH_NAME} - First failure")
                 }
             }

barcodes/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
-    <version>7.1.11</version>
+    <version>7.1.12</version>
   </parent>
   <artifactId>barcodes</artifactId>
   <name>iText 7 - barcodes</name>

font-asian/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
-    <version>7.1.11</version>
+    <version>7.1.12</version>
   </parent>
   <artifactId>font-asian</artifactId>
   <name>iText 7 - Asian fonts</name>
@@ -21,33 +21,26 @@
   <build>
     <plugins>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-failsafe-plugin</artifactId>
-        <version>${failsafe.version}</version>
         <configuration>
           <skip>true</skip>
         </configuration>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>${javadoc.version}</version>
         <configuration>
           <skip>true</skip>
         </configuration>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>${surefire.version}</version>
         <configuration>
           <skip>true</skip>
         </configuration>
       </plugin>
       <plugin>
         <groupId>org.pitest</groupId>
         <artifactId>pitest-maven</artifactId>
-        <version>${pitest.version}</version>
         <configuration>
           <skip>true</skip>
         </configuration>

forms/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
-    <version>7.1.11</version>
+    <version>7.1.12</version>
   </parent>
   <artifactId>forms</artifactId>
   <name>iText 7 - forms</name>

forms/src/main/java/com/itextpdf/forms/PdfAcroForm.java

@@ -730,10 +730,9 @@ public void flattenFields() {
             PdfDictionary parent = fieldObject.getAsDictionary(PdfName.Parent);
             if (parent != null) {
                 PdfArray kids = parent.getAsArray(PdfName.Kids);
-                if(kids!=null) {
+                if (kids != null) {
                     kids.remove(fieldObject);
-                    // TODO what if parent was in it's turn the only child of it's parent (parent of parent)?
-                    // shouldn't we remove them recursively? check it
+                    // TODO DEVSIX-2715 if parent was in it's turn the only child of it's parent, we should remove them recursively
                     if (kids.isEmpty()) {
                         fFields.remove(parent);
                     }
@@ -976,7 +975,7 @@ private void addWidgetAnnotationToPage(PdfPage page, PdfAnnotation annot) {
         boolean tagged = page.getDocument().isTagged();
         if (tagged) {
             tagPointer = page.getDocument().getTagStructureContext().getAutoTaggingPointer();
-            //TODO attributes?
+            //TODO DEVSIX-4117 PrintField attributes
             tagPointer.addTag(StandardRoles.FORM);
         }
 
@@ -1036,6 +1035,16 @@ public void release() {
         fields = null;
     }
 
+    @Override
+    public PdfObjectWrapper<PdfDictionary> setModified() {
+        if (getPdfObject().getIndirectReference() != null) {
+            super.setModified();
+        } else {
+            document.getCatalog().setModified();
+        }
+        return this;
+    }
+
     private static PdfDictionary createAcroFormDictionaryByFields(PdfArray fields) {
         PdfDictionary dictionary = new PdfDictionary();
         dictionary.put(PdfName.Fields, fields);

forms/src/main/java/com/itextpdf/forms/fields/PdfFormField.java

@@ -89,6 +89,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.xobject.PdfImageXObject;
 import com.itextpdf.layout.Canvas;
 import com.itextpdf.layout.Style;
+import com.itextpdf.layout.element.Div;
 import com.itextpdf.layout.element.Paragraph;
 import com.itextpdf.layout.element.Text;
 import com.itextpdf.layout.layout.LayoutArea;
@@ -2608,11 +2609,17 @@ private void drawChoiceAppearance(Rectangle rect, float fontSize, String value,
 
         Canvas modelCanvas = new Canvas(canvas, new Rectangle(3, 0, Math.max(0, width - widthBorder), Math.max(0, height - heightBorder)));
         modelCanvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, true);
+        Div div = new Div();
+        if(getFieldFlag(PdfChoiceFormField.FF_COMBO)) {
+            div.setVerticalAlignment(VerticalAlignment.MIDDLE);
+        }
+        div.setHeight(Math.max(0, height - heightBorder));
         for (int index = 0; index < strings.size(); index++) {
             Boolean isFull = modelCanvas.getRenderer().getPropertyAsBoolean(Property.FULL);
             if (Boolean.TRUE.equals(isFull)) {
                 break;
             }
+
             Paragraph paragraph = new Paragraph(strings.get(index)).setFont(font).setFontSize(fontSize).setMargins(0, 0, 0, 0).setMultipliedLeading(1);
             paragraph.setProperty(Property.FORCED_PLACEMENT, true);
             paragraph.setTextAlignment(convertJustificationToTextAlignment());
@@ -2636,8 +2643,9 @@ private void drawChoiceAppearance(Rectangle rect, float fontSize, String value,
                     }
                 }
             }
-            modelCanvas.add(paragraph);
+            div.add(paragraph);
         }
+        modelCanvas.add(div);
         canvas.
                 restoreState().
                 endVariableText();
@@ -2891,15 +2899,15 @@ protected void drawPdfA2CheckAppearance(float width, float height, String onStat
     }
 
     /**
+     * Draws PDF/A-1 compliant check appearance.
+     * 
      * @param width         width of the checkbox
      * @param height        height of the checkbox
      * @param selectedValue the selected value of the checkbox which determines the appearance of the checkbox
      * @param checkType     the type that determines how the checkbox will look like. Allowed values are {@value TYPE_CHECK},
      *                      {@value TYPE_CIRCLE}, {@value TYPE_CROSS}, {@value TYPE_DIAMOND}, {@value TYPE_SQUARE}, {@value TYPE_STAR}
      * @deprecated use {@link #drawPdfA2CheckAppearance(float, float, String, int)} instead.
      */
-    // TODO when removing the method: check {@link #drawCheckBox(PdfCanvas, float, float, float, boolean)} and consider
-    //  removing last redundant "on" parameter
     @Deprecated
     protected void drawPdfA1CheckAppearance(float width, float height, String selectedValue, int checkType) {
         PdfStream stream = (PdfStream) new PdfStream().makeIndirect(getDocument());