Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Redactions Kotlin sample #13

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Add Redactions Kotlin sample #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60c2fb4
Add Redactions Kotlin sample
datalogics-saharay Feb 21, 2024
9f58262
Merge branch 'develop' into add-redactions-kotlin-sample
datalogics-saharay Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test-kotlin-samples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
strategy:
matrix:
os: [windows-latest, ubuntu-latest]
dir: ['TextExtract', 'FlattenTransparency', 'SplitPDF', 'ConvertToOffice', 'MergePDF', 'ListWords', 'PDFOptimize', 'PDFAConverter']
dir: ['TextExtract', 'FlattenTransparency', 'SplitPDF', 'ConvertToOffice', 'MergePDF', 'ListWords', 'PDFOptimize', 'PDFAConverter', 'Redactions']
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
14 changes: 14 additions & 0 deletions Redactions/.idea/runConfigurations/Redactions.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

231 changes: 231 additions & 0 deletions Redactions/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.datalogics.pdfl.samples</groupId>
<artifactId>Redactions</artifactId>
<version>1.0-SNAPSHOT</version>

<repositories>
<repository>
<id>mavenCentral</id>
<url>https://repo1.maven.org/maven2/</url>
</repository>
</repositories>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<kotlin.code.style>official</kotlin.code.style>
<kotlin.compiler.jvmTarget>1.8</kotlin.compiler.jvmTarget>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>

<profiles>
<profile>
<id>Windows64</id>
<activation>
<os>
<family>windows</family>
<arch>amd64</arch>
</os>
</activation>
<properties>
<jni.classifier>win-x86-64-jni</jni.classifier>
</properties>
</profile>
<profile>
<id>MacArm</id>
<activation>
<os>
<family>mac</family>
<arch>aarch64</arch>
</os>
</activation>
<properties>
<jni.classifier>mac-arm-64-jni</jni.classifier>
</properties>
</profile>
<profile>
<id>Linux64</id>
<activation>
<os>
<!-- Use OS <name> instead of <family> because the "unix" <family> also includes Mac -->
<name>Linux</name>
<arch>amd64</arch>
</os>
</activation>
<properties>
<jni.classifier>linux-x86-64-jni</jni.classifier>
</properties>
</profile>
</profiles>

<dependencies>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib-jdk8</artifactId>
<version>1.9.21</version>
</dependency>
<dependency>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<version>18.31.0</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<version>18.31.0</version>
</dependency>
<dependency>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<version>18.31.0</version>
<type>zip</type>
<classifier>${jni.classifier}</classifier>
</dependency>
<dependency>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<version>18.31.0</version>
<type>zip</type>
<classifier>resources</classifier>
</dependency>
<dependency>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<version>18.31.0</version>
<classifier>javadoc</classifier>
</dependency>
</dependencies>

<build>
<sourceDirectory>src/main/kotlin</sourceDirectory>
<plugins>
<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>1.9.21</version>
<executions>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
</plugin>
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
<version>2.22.2</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.6.0</version>
<configuration>
<mainClass>Redactions</mainClass>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack-resources</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<classifier>resources</classifier>
<type>zip</type>
<outputDirectory>${project.build.directory}/lib/Resources</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
</execution>
<execution>
<id>unpack-jni</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<classifier>${jni.classifier}</classifier>
<type>zip</type>
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
</execution>
<execution>
<id>unpack-license</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>com.datalogics.pdfl</groupId>
<artifactId>pdfl</artifactId>
<classifier>license</classifier>
<type>zip</type>
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<mainClass>com.datalogics.pdfl.samples.RedactionsKt</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>3.0.2</version>
</plugin>
</plugins>
</pluginManagement>
</build>

</project>
102 changes: 102 additions & 0 deletions Redactions/src/main/kotlin/com/datalogics/pdfl/samples/Redactions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
package com.datalogics.pdfl.samples

import com.datalogics.PDFL.*
import java.util.*

/*
* This sample shows how to redact a PDF document. The program opens an input PDF, searches for
* specific words using the WordFinder, and then removes these words from the text.
*
* Copyright (c) 2024, Datalogics, Inc. All rights reserved.
*
*/
fun main(args: Array<String>) {
println("Redactions sample:")
val lib = Library()

try {
println("Initialized the library.")

var sInput = Library.getResourceDirectory() + "Sample_Input/sample.pdf"
var sOutput = "Redactions-out-applied.pdf"

if (args.isNotEmpty()){
sInput = args[0]
}

if (args.size > 1){
sOutput = args[1]
}

val doc = Document(sInput)
println("Input file: $sInput, will write to $sOutput")

val currentPage = doc.getPage(0)

// Redact occurrences of the word "rain" on the page.
// Redact occurrences of the word "cloudy" on the page, changing the display details.
//
// For a more in-depth example of using the WordFinder, see the TextExtract sample.
//
val rainQuads: MutableList<Quad> = ArrayList()
val cloudyQuads: MutableList<Quad> = ArrayList()

val wordConfig = WordFinderConfig().apply {
disableTaggedPDF = true
ignoreCharGaps = true
}

val wordFinder = WordFinder(doc, WordFinderVersion.LATEST, wordConfig)
val pageWords = wordFinder.getWordList(0)

for (word in pageWords) {
val currentWord = word.text.lowercase()
print(" $currentWord")

// Store the Quads of all "Cloudy" words in a list for later use in
// creating the redaction object.
if (currentWord.contains("rain")) {
println("\nFound \"${word.text}\" on page 0 ")
rainQuads.addAll(word.quads)
} else if (currentWord.contains("cloudy")) {
println("\nFound \"${word.text}\" on page 0 ")
cloudyQuads.addAll(word.quads)
}
}

val red = Color(1.0, 0.0, 0.0)
val green = Color(0.0, 1.0, 0.0)
val white = Color(1.0)

println("\nFound ${cloudyQuads.size} \"cloudy\" instances.")
val notCloudy = Redaction(currentPage, cloudyQuads, red).apply {
// Fill the "normal" appearance of text with 25% opaque red;
fillNormal = true
setFillColor(red, 0.25)
}

println("\nFound ${rainQuads.size} \"rain\" instances.")
val annot = Redaction(currentPage, rainQuads)
annot.internalColor = green
annot.textColor = white
annot.fontFace = "CourierStd"
annot.fontSize = 8.0

// Fill the redaction with the word "rain", drawn in white
annot.overlayText = "rain"
annot.repeat = true
annot.scaleToFit = true

// Update the page's content and save the file with clipping
currentPage.updateContent()

doc.save(EnumSet.of(SaveFlags.FULL), "Redactions-out.pdf")

// Actually redact the instances of the found word
doc.applyRedactions()

doc.save(EnumSet.of(SaveFlags.FULL), sOutput)
} finally {
lib.delete()
}
}
Loading