pdfcpu

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2017 License: MIT Imports: 17 Imported by: 0

README

Build Status GoDoc Coverage Status Go Report Card

logo

pdfcpu: a golang pdf processor

Package pdfcpu is a simple PDF processing library written in Go. It provides both an API and a command line tool. Supported are all versions up to PDF 1.7 (ISO-32000).

Motivation

Reducing the size of large PDF files for mass mailings by optimization to the bare minimum. This can be achieved by analyzing a PDF's cross reference table, removing redundant embedded resources like font files or images and by always writing back the file maxing out PDF compression.

I also wanted to have my own swiss army knife for PDFs written entirely in Go that allows me to trim, split and merge PDF content.

Features
  • Validate (validates PDF files up to version 7.0)
  • Read (builds xref table from PDF file)
  • Write (writes xref table to PDF file)
  • Optimize (gets rid of redundancies like duplicate fonts, images)
  • Split (split a multi page PDF file into single page PDF files)
  • Merge (a set of PDF files into one consolidated PDF file)
  • Extract Images (extract all embedded images of a PDF file into a given dir)
  • Extract Fonts (extract all embedded fonts of a PDF file into a given dir)
  • Extract Pages (extract specific pages into a given dir)
  • Extract Content (extract the PDF-Source into given dir)
  • Trim (generate a custom version of a PDF file)
  • Encrypt (sets password protection)
  • Decrypt (removes password protection)
  • Change user/owner password
Demo Screencast

asciicast

Installation

go get github.com/hhrutter/pdfcpu/cmd/...

Usage
pdfcpu validate [-verbose] [-mode strict|relaxed] [-upw userpw] [-opw ownerpw] inFile

pdfcpu optimize [-verbose] [-stats csvFile] [-upw userpw] [-opw ownerpw] inFile [outFile]

pdfcpu split [-verbose] [-upw userpw] [-opw ownerpw] inFile outDir

pdfcpu merge [-verbose] outFile inFile1 inFile2 ...

pdfcpu extract [-verbose] -mode image|font|content|page [-pages pageSelection] [-upw userpw] [-opw ownerpw] inFile outDir

pdfcpu trim [-verbose] -pages pageSelection [-upw userpw] [-opw ownerpw] inFile outFile

pdfcpu encrypt [-verbose] [-upw userpw] [-opw ownerpw] inFile [outFile]

pdfcpu decrypt [-verbose] [-upw userpw] [-opw ownerpw] inFile [outFile]

pdfcpu changeupw [-verbose] [-opw ownerpw] inFile upwOld upwNew

pdfcpu changeopw [-verbose] [-upw userpw] inFile opwOld opwNew

Please read the documentation

Status

Version: 0.1.2

  • Encryption support including changing passwords is available for the PDF standard security handler.
  • "Encrypt" uses AES with a 128 bit encryption key.
  • The extraction code for font files and images is experimental and serves as proof of concept only.
To Do
  • validation of the less used PDF page entry element "PresSteps"
  • validation of the less used PDF root entry elements "SpiderInfo", "Permissions", "Legal" and "Collection"

I am looking for PDFs using one of these features in order to implement validation. If you have one and you can share let me know.

Contributing

Pull requests, bug fixes and issue reports are always welcome.

Please open an issue if you want to propose a change.

PDF files that will increase pdfcpu's coverage are very much welcome.

Disclaimer

Usage of pdfcpu assumes you know about and respect all copyrights of any PDF content you may be processing. This applies to the PDF files as such, their content and in particular all embedded resources like font files or images. Credit goes to Renee French for creating our beloved Gopher.

License

MIT

Documentation

Overview

Package pdfcpu is a simple PDF processing library written in Go. It provides both an API and a command line tool. Supported are all versions up to PDF 1.7 (ISO-32000).

The available commands are: 

validate	validate PDF against PDF 32000-1:2008 (PDF 1.7)
optimize	optimize PDF by getting rid of redundant page resources
split		split multi-page PDF into several single-page PDFs
merge		concatenate 2 or more PDFs
extract		extract images, fonts, content, pages out of a PDF
trim		create trimmed version of a PDF
encrypt		set password
decrypt		remove password
changeupw	change user password
changeopw	change owner password
version		print pdfcpu version

Index

Examples

Constants

View Source 
const (
	VALIDATE commandMode = iota
	OPTIMIZE
	SPLIT
	MERGE
	EXTRACTIMAGES
	EXTRACTFONTS
	EXTRACTPAGES
	EXTRACTCONTENT
	TRIM
	ENCRYPT
	DECRYPT
	CHANGEUPW
	CHANGEOPW
)

The available commands for the CLI.

Variables

This section is empty.

Functions

func ChangeOwnerPassword added in v0.1.1 

func ChangeOwnerPassword(fileIn, fileOut string, config *types.Configuration, pwOld, pwNew *string) (err error)

ChangeOwnerPassword of fileIn and write result to fileOut.

func ChangeUserPassword added in v0.1.1 

func ChangeUserPassword(fileIn, fileOut string, config *types.Configuration, pwOld, pwNew *string) (err error)

ChangeUserPassword of fileIn and write result to fileOut.

func Decrypt added in v0.1.1 

func Decrypt(fileIn, fileOut string, config *types.Configuration) (err error)

Decrypt fileIn and write result to fileOut.

func Encrypt added in v0.1.1 

func Encrypt(fileIn, fileOut string, config *types.Configuration) (err error)

Encrypt fileIn and write result to fileOut.

func ExtractContent 

func ExtractContent(fileIn, dirOut string, pageSelection *[]string, config *types.Configuration) (err error)

ExtractContent dumps "PDF source" files from fileIn into dirOut for selected pages.

func ExtractFonts 

func ExtractFonts(fileIn, dirOut string, pageSelection *[]string, config *types.Configuration) (err error)

ExtractFonts dumps embedded fontfiles from fileIn into dirOut for selected pages.

func ExtractImages 

func ExtractImages(fileIn, dirOut string, pageSelection *[]string, config *types.Configuration) (err error)

ExtractImages dumps embedded image resources from fileIn into dirOut for selected pages.

func ExtractPages 

func ExtractPages(fileIn, dirOut string, pageSelection *[]string, config *types.Configuration) (err error)

ExtractPages generates single page PDF files from fileIn in dirOut for selected pages.

func Merge 

func Merge(filesIn []string, fileOut string, config *types.Configuration) (err error)

Merge some PDF files together and write the result to fileOut. This corresponds to concatenating these files in the order specified by filesIn. The first entry of filesIn serves as the destination xRefTable where all the remaining files gets merged into.

func Optimize 

func Optimize(fileIn, fileOut string, config *types.Configuration) (err error)

Optimize reads in fileIn, does validation, optimization and writes the result to fileOut.

func ParsePageSelection 

func ParsePageSelection(s string) (ps []string, err error)

ParsePageSelection ensures a correct page selection expression.

func Process 

func Process(cmd *Command) (err error)

Process executes a pdfcpu command.

Example (ChangeOwnerPW) 
config := types.NewDefaultConfiguration()

// supply existing user pw like so
config.UserPW = "upw"

// old and new owner pw
pwOld := "pwOld"
pwNew := "pwNew"

cmd := ChangeOwnerPWCommand("in.pdf", "out.pdf", config, &pwOld, &pwNew)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (ChangeUserPW) 
config := types.NewDefaultConfiguration()

// supply existing owner pw like so
config.OwnerPW = "opw"

pwOld := "pwOld"
pwNew := "pwNew"

cmd := ChangeUserPWCommand("in.pdf", "out.pdf", config, &pwOld, &pwNew)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Decrypt) 
config := types.NewDefaultConfiguration()

config.UserPW = "upw"
config.OwnerPW = "opw"

cmd := DecryptCommand("in.pdf", "out.pdf", config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Encrypt) 
config := types.NewDefaultConfiguration()

config.UserPW = "upw"
config.OwnerPW = "opw"

cmd := EncryptCommand("in.pdf", "out.pdf", config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (ExtractImages) 
// Extract all embedded images for first 5 and last 5 pages but not for page 4.
selectedPages := []string{"-5", "5-", "!4"}

config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

cmd := ExtractImagesCommand("in.pdf", "dirOut", selectedPages, config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (ExtractPages) 
// Extract single-page PDFs for pages 3, 4 and 5.
selectedPages := []string{"3..5"}

config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

cmd := ExtractPagesCommand("in.pdf", "dirOut", selectedPages, config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Merge) 
// Concatenate this sequence of PDF files:
filenamesIn := []string{"in1.pdf", "in2.pdf", "in3.pdf"}

cmd := MergeCommand(filenamesIn, "out.pdf", types.NewDefaultConfiguration())

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Optimize) 
config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

// Generate optional stats.
config.StatsFileName = "stats.csv"

// Configure end of line sequence for writing.
config.Eol = types.EolLF

cmd := OptimizeCommand("in.pdf", "out.pdf", config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Split) 
config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

// Split into single-page PDFs.
cmd := SplitCommand("in.pdf", "outDir", config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Trim) 
// Trim to first three pages.
selectedPages := []string{"-3"}

config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

cmd := TrimCommand("in.pdf", "out.pdf", selectedPages, config)

err := Process(&cmd)
if err != nil {
	return
}

Output:
Example (Validate) 
config := types.NewDefaultConfiguration()

// Set optional password(s).
//config.UserPW = "upw"
//config.OwnerPW = "opw"

// Set relaxed validation mode.
config.SetValidationRelaxed()

cmd := ValidateCommand("in.pdf", config)

err := Process(&cmd)
if err != nil {
	return
}

Output:

func Read 

func Read(fileIn string, config *types.Configuration) (ctx *types.PDFContext, err error)

Read reads in a PDF file and builds an internal structure holding its cross reference table aka the PDFContext.

func Split 

func Split(fileIn, dirOut string, config *types.Configuration) (err error)

Split generates a sequence of single page PDF files in dirOut creating one file for every page of inFile.

func Trim 

func Trim(fileIn, fileOut string, pageSelection *[]string, config *types.Configuration) (err error)

Trim generates a trimmed version of fileIn containing all pages selected.

func Validate 

func Validate(fileIn string, config *types.Configuration) (err error)

Validate validates a PDF file against ISO-32000-1:2008.

func Verbose 

func Verbose(verbose bool)

Verbose controls logging output.

func Write 

func Write(ctx *types.PDFContext) (err error)

Write generates a PDF file for a given PDFContext.

Types

type Command 

type Command struct {
	Mode          commandMode          // VALIDATE  OPTIMIZE  SPLIT  MERGE  EXTRACT  TRIM  ENCRYPT  DECRYPT  CHANGEUPW  CHANGEOPW
	InFile        *string              //    *         *        *      -       *      *       *        *         *          *
	InFiles       *[]string            //    -         -        -      *       -      -       -        -         -          -
	OutFile       *string              //    -         *        -      *       -      *       *        *         *          *
	OutDir        *string              //    -         -        *      -       *      -       -        -         -          -
	PageSelection *[]string            //    -         -        -      -       *      *       -        -         -          -
	Config        *types.Configuration //    *         *        *      *       *      *       *        *         *          *
	PWOld         *string              //    -         -        -      -       -      -       -        -         *          *
	PWNew         *string              //    -         -        -      -       -      -       -        -         *          *
}

Command represents an execution context.

func ChangeOwnerPWCommand added in v0.1.1 

func ChangeOwnerPWCommand(pdfFileNameIn, pdfFileNameOut string, config *types.Configuration, pwOld, pwNew *string) Command

ChangeOwnerPWCommand creates a new ChangeOwnerPWCommand.

func ChangeUserPWCommand added in v0.1.1 

func ChangeUserPWCommand(pdfFileNameIn, pdfFileNameOut string, config *types.Configuration, pwOld, pwNew *string) Command

ChangeUserPWCommand creates a new ChangeUserPWCommand.

func DecryptCommand added in v0.1.1 

func DecryptCommand(pdfFileNameIn, pdfFileNameOut string, config *types.Configuration) Command

DecryptCommand creates a new DecryptCommand.

func EncryptCommand added in v0.1.1 

func EncryptCommand(pdfFileNameIn, pdfFileNameOut string, config *types.Configuration) Command

EncryptCommand creates a new EncryptCommand.

func ExtractContentCommand 

func ExtractContentCommand(pdfFileNameIn, dirNameOut string, pageSelection []string, config *types.Configuration) Command

ExtractContentCommand creates a new ExtractContentCommand.

func ExtractFontsCommand 

func ExtractFontsCommand(pdfFileNameIn, dirNameOut string, pageSelection []string, config *types.Configuration) Command

ExtractFontsCommand creates a new ExtractFontsCommand. (experimental)

func ExtractImagesCommand 

func ExtractImagesCommand(pdfFileNameIn, dirNameOut string, pageSelection []string, config *types.Configuration) Command

ExtractImagesCommand creates a new ExtractImagesCommand. (experimental)

func ExtractPagesCommand 

func ExtractPagesCommand(pdfFileNameIn, dirNameOut string, pageSelection []string, config *types.Configuration) Command

ExtractPagesCommand creates a new ExtractPagesCommand.

func MergeCommand 

func MergeCommand(pdfFileNamesIn []string, pdfFileNameOut string, config *types.Configuration) Command

MergeCommand creates a new MergeCommand.

func OptimizeCommand 

func OptimizeCommand(pdfFileNameIn, pdfFileNameOut string, config *types.Configuration) Command

OptimizeCommand creates a new OptimizeCommand.

func SplitCommand 

func SplitCommand(pdfFileNameIn, dirNameOut string, config *types.Configuration) Command

SplitCommand creates a new SplitCommand.

func TrimCommand 

func TrimCommand(pdfFileNameIn, pdfFileNameOut string, pageSelection []string, config *types.Configuration) Command

TrimCommand creates a new TrimCommand.

func ValidateCommand 

func ValidateCommand(pdfFileName string, config *types.Configuration) Command

ValidateCommand creates a new ValidateCommand.

Source Files

View all Source files

Directories

Path Synopsis
cmd
pdfcpu
Package crypto provides PDF encryption plumbing code.
 Package crypto provides PDF encryption plumbing code.
Package extract provides methods for extracting fonts, images, pages and page content.
 Package extract provides methods for extracting fonts, images, pages and page content.
Package filter contains implementations for PDF filters.
 Package filter contains implementations for PDF filters.
Package merge provides code for merging two PDFContexts.
 Package merge provides code for merging two PDFContexts.
Package optimize contains code for optimizing the resources of a PDF file.
 Package optimize contains code for optimizing the resources of a PDF file.
Package read provides methods for parsing PDF files into memory.
 Package read provides methods for parsing PDF files into memory.
Package types provides the PDFContext, representing an ecosystem for PDF processing.
 Package types provides the PDFContext, representing an ecosystem for PDF processing.
Package validate contains validation code for ISO 32000-1:2008.
 Package validate contains validation code for ISO 32000-1:2008.
Package write contains code that writes PDF data from memory to a file.
 Package write contains code that writes PDF data from memory to a file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.