Merge pull request #140 from gunnsth/release/v3.1.1

Release unipdf v3.1.1

Author: gunnsth

README.md

@@ -21,6 +21,7 @@ creating and reading, processing PDF files. The library is written and supported
 - [Rotate pages](https://github.com/unidoc/unipdf-examples/blob/v3/pages/pdf_rotate.go)
 - [Extract text from PDF files](https://github.com/unidoc/unipdf-examples/blob/v3/text/pdf_extract_text.go)
 - [Text extraction support with size, position and formatting info](https://github.com/unidoc/unipdf-examples/blob/v3/text/pdf_text_locations.go)
+- [PDF to CSV](https://github.com/unidoc/unipdf-examples/blob/v3/text/pdf_to_csv.go) illustrates extracting tabular data from PDF.
 - [Extract images](https://github.com/unidoc/unipdf-examples/blob/v3/image/pdf_extract_images.go) with coordinates
 - [Images to PDF](https://github.com/unidoc/unipdf-examples/blob/v3/image/pdf_images_to_pdf.go)
 - [Add images to pages](https://github.com/unidoc/unipdf-examples/blob/v3/image/pdf_add_image_to_page.go)
@@ -42,12 +43,6 @@ as well as [documented examples](https://unidoc.io/examples) on our website.
 
 Contact us if you need any specific examples.
 
-## News
-- unidoc has been renamed to unipdf and is maintained under https://github.com/unidoc/unipdf
-- The old repository remains under https://github.com/unidoc/unidoc for backwards compatibility and will be read-only.
-All development is under the unipdf repository.
-- The initial release of unipdf v3.0.0 is compatible with Go modules from the start.
-
 ## Installation
 With modules:
 ~~~
@@ -111,10 +106,18 @@ To use unipdf in your projects, you need to get a license.
 
 Get your license on [https://unidoc.io](https://unidoc.io).
 
-To load your license, simply do:
+The easiest way to load your license is through environment variables, for example:
+```bash
+export UNIPDF_CUSTOMER_NAME=UniDoc
+export UNIPDF_LICENSE_PATH=/path/to/licenses/UniDoc.txt
+```
+
+Alternatively you can load the license in code, simply do:
 ```go
-unidocLicenseKey := "... your license here ..."
-err := license.SetLicenseKey(unidocLicenseKey)
+licenseKey := "... your license here ..."
+customerName := `name of license holder`
+
+err := license.SetLicenseKey(licenseKey, customerName)
 if err != nil {
     fmt.Printf("Error loading license: %v\n", err)
     os.Exit(1)

annotator/field_appearance.go

@@ -245,7 +245,7 @@ func genFieldTextAppearance(wa *model.PdfAnnotationWidget, ftxt *model.PdfFieldT
 
 	// If fontname not set need to make a new font or use one defined in the resources.
 	// e.g. Helv commonly used for Helvetica.
-	if fontname == nil {
+	if fontname == nil || dr == nil {
 		// Font not set, revert to Helvetica with name "Helv".
 		fontname = core.MakeName("Helv")
 		helv, err := model.NewStandard14Font("Helvetica")
@@ -565,7 +565,7 @@ func genFieldTextCombAppearance(wa *model.PdfAnnotationWidget, ftxt *model.PdfFi
 
 	// If fontname not set need to make a new font or use one defined in the resources.
 	// e.g. Helv commonly used for Helvetica.
-	if fontname == nil {
+	if fontname == nil || dr == nil {
 		// Font not set, revert to Helvetica with name "Helv".
 		fontname = core.MakeName("Helv")
 		helv, err := model.NewStandard14Font("Helvetica")
@@ -940,7 +940,7 @@ func makeComboboxTextXObjForm(width, height float64, text string, style Appearan
 
 	// If fontname not set need to make a new font or use one defined in the resources.
 	// e.g. Helv commonly used for Helvetica.
-	if fontname == nil {
+	if fontname == nil || dr == nil {
 		// Font not set, revert to Helvetica with name "Helv".
 		fontname = core.MakeName("Helv")
 		helv, err := model.NewStandard14Font("Helvetica")

common/license/util.go

@@ -8,10 +8,14 @@ package license
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
 	"strings"
+
+	"github.com/unidoc/unipdf/v3/common"
 )
 
-// Defaults to the open source license.
+// Defaults to unlicensed.
 var licenseKey = MakeUnlicensedKey()
 
 // SetLicenseKey sets and validates the license key.
@@ -35,6 +39,29 @@ func SetLicenseKey(content string, customerName string) error {
 	return nil
 }
 
+const licensePathEnvironmentVar = `UNIPDF_LICENSE_PATH`
+const licenseCustomerNameEnvironmentVar = `UNIPDF_CUSTOMER_NAME`
+
+func init() {
+	lpath := os.Getenv(licensePathEnvironmentVar)
+	custName := os.Getenv(licenseCustomerNameEnvironmentVar)
+
+	if len(lpath) == 0 || len(custName) == 0 {
+		return
+	}
+
+	data, err := ioutil.ReadFile(lpath)
+	if err != nil {
+		common.Log.Debug("Unable to read license file: %v", err)
+		return
+	}
+	err = SetLicenseKey(string(data), custName)
+	if err != nil {
+		common.Log.Debug("Unable to load license: %v", err)
+		return
+	}
+}
+
 func GetLicenseKey() *LicenseKey {
 	if licenseKey == nil {
 		return nil

common/version.go

@@ -11,12 +11,12 @@ import (
 )
 
 const releaseYear = 2019
-const releaseMonth = 7
-const releaseDay = 18
-const releaseHour = 19
+const releaseMonth = 8
+const releaseDay = 4
+const releaseHour = 11
 const releaseMin = 40
 
 // Version holds version information, when bumping this make sure to bump the released at stamp also.
-const Version = "3.1.0"
+const Version = "3.1.1"
 
 var ReleasedAt = time.Date(releaseYear, releaseMonth, releaseDay, releaseHour, releaseMin, 0, 0, time.UTC)

core/primitives.go

@@ -541,7 +541,7 @@ func GetNumberAsFloat(obj PdfObject) (float64, error) {
 
 // IsNullObject returns true if `obj` is a PdfObjectNull.
 func IsNullObject(obj PdfObject) bool {
-	_, isNull := obj.(*PdfObjectNull)
+	_, isNull := TraceToDirectObject(obj).(*PdfObjectNull)
 	return isNull
 }
 

creator/block.go

@@ -93,9 +93,19 @@ func NewBlockFromPage(page *model.PdfPage) (*Block, error) {
 	b.width = mbox.Urx - mbox.Llx
 	b.height = mbox.Ury - mbox.Lly
 
+	// Inherit page rotation angle.
+	if page.Rotate != nil {
+		b.angle = -float64(*page.Rotate)
+	}
+
 	return b, nil
 }
 
+// Angle returns the block rotation angle in degrees.
+func (blk *Block) Angle() float64 {
+	return blk.angle
+}
+
 // SetAngle sets the rotation angle in degrees.
 func (blk *Block) SetAngle(angleDeg float64) {
 	blk.angle = angleDeg
@@ -132,47 +142,39 @@ func (blk *Block) duplicate() *Block {
 // GeneratePageBlocks draws the block contents on a template Page block.
 // Implements the Drawable interface.
 func (blk *Block) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error) {
-	var blocks []*Block
+	cc := contentstream.NewContentCreator()
 
+	// Position block.
+	blkWidth, blkHeight := blk.Width(), blk.Height()
 	if blk.positioning.isRelative() {
-		// Draw at current ctx.X, ctx.Y position
-		dup := blk.duplicate()
-		cc := contentstream.NewContentCreator()
-		cc.Translate(ctx.X, ctx.PageHeight-ctx.Y-blk.height)
-		if blk.angle != 0 {
-			// Make the rotation about the upper left corner.
-			// TODO: Account for rotation origin. (Consider).
-			cc.Translate(0, blk.Height())
-			cc.RotateDeg(blk.angle)
-			cc.Translate(0, -blk.Height())
-		}
-		contents := append(*cc.Operations(), *dup.contents...)
-		contents.WrapIfNeeded()
-		dup.contents = &contents
+		// Relative. Draw at current ctx.X, ctx.Y position.
+		cc.Translate(ctx.X, ctx.PageHeight-ctx.Y-blkHeight)
+	} else {
+		// Absolute. Draw at blk.xPos, blk.yPos position.
+		cc.Translate(blk.xPos, ctx.PageHeight-blk.yPos-blkHeight)
+	}
 
-		blocks = append(blocks, dup)
+	// Rotate block.
+	rotatedHeight := blkHeight
+	if blk.angle != 0 {
+		// Make the rotation about the center of the block.
+		cc.Translate(blkWidth/2, blkHeight/2)
+		cc.RotateDeg(blk.angle)
+		cc.Translate(-blkWidth/2, -blkHeight/2)
 
-		ctx.Y += blk.height
-	} else {
-		// Absolute. Draw at blk.xPos, blk.yPos position
-		dup := blk.duplicate()
-		cc := contentstream.NewContentCreator()
-		cc.Translate(blk.xPos, ctx.PageHeight-blk.yPos-blk.height)
-		if blk.angle != 0 {
-			// Make the rotation about the upper left corner.
-			// TODO: Consider supporting specification of rotation origin.
-			cc.Translate(0, blk.Height())
-			cc.RotateDeg(blk.angle)
-			cc.Translate(0, -blk.Height())
-		}
-		contents := append(*cc.Operations(), *dup.contents...)
-		contents.WrapIfNeeded()
-		dup.contents = &contents
+		_, rotatedHeight = blk.RotatedSize()
+	}
 
-		blocks = append(blocks, dup)
+	if blk.positioning.isRelative() {
+		ctx.Y += rotatedHeight
 	}
 
-	return blocks, ctx, nil
+	dup := blk.duplicate()
+	contents := append(*cc.Operations(), *dup.contents...)
+	contents.WrapIfNeeded()
+	dup.contents = &contents
+
+	return []*Block{dup}, ctx, nil
 }
 
 // Height returns the Block's height.
@@ -185,6 +187,12 @@ func (blk *Block) Width() float64 {
 	return blk.width
 }
 
+// RotatedSize returns the width and height of the rotated block.
+func (blk *Block) RotatedSize() (float64, float64) {
+	_, _, w, h := rotateRect(blk.width, blk.height, blk.angle)
+	return w, h
+}
+
 // addContents adds contents to a block.  Wrap both existing and new contents to ensure
 // independence of content operations.
 func (blk *Block) addContents(operations *contentstream.ContentStreamOperations) {
@@ -335,8 +343,7 @@ func (blk *Block) Draw(d Drawable) error {
 	}
 
 	for _, newBlock := range blocks {
-		err := mergeContents(blk.contents, blk.resources, newBlock.contents, newBlock.resources)
-		if err != nil {
+		if err := blk.mergeBlocks(newBlock); err != nil {
 			return err
 		}
 	}
@@ -356,8 +363,7 @@ func (blk *Block) DrawWithContext(d Drawable, ctx DrawContext) error {
 	}
 
 	for _, newBlock := range blocks {
-		err := mergeContents(blk.contents, blk.resources, newBlock.contents, newBlock.resources)
-		if err != nil {
+		if err := blk.mergeBlocks(newBlock); err != nil {
 			return err
 		}
 	}

creator/creator.go

@@ -20,6 +20,8 @@ import (
 // content onto imported PDF pages, etc.
 type Creator struct {
 	pages      []*model.PdfPage
+	pageBlocks map[*model.PdfPage]*Block
+
 	activePage *model.PdfPage
 
 	pagesize PageSize
@@ -116,6 +118,7 @@ type margins struct {
 func New() *Creator {
 	c := &Creator{}
 	c.pages = []*model.PdfPage{}
+	c.pageBlocks = map[*model.PdfPage]*Block{}
 	c.SetPageSize(PageSizeLetter)
 
 	m := 0.1 * c.pageWidth
@@ -513,6 +516,15 @@ func (c *Creator) finalize() error {
 				return err
 			}
 		}
+
+		// Draw blocks to pages.
+		block, ok := c.pageBlocks[page]
+		if !ok {
+			return errors.New("could not find page block")
+		}
+		if err := block.drawToPage(page); err != nil {
+			return err
+		}
 	}
 
 	c.finalized = true
@@ -559,15 +571,21 @@ func (c *Creator) Draw(d Drawable) error {
 		return err
 	}
 
-	for idx, blk := range blocks {
+	for idx, block := range blocks {
 		if idx > 0 {
 			c.NewPage()
 		}
 
-		p := c.getActivePage()
-		err := blk.drawToPage(p)
-		if err != nil {
-			return err
+		page := c.getActivePage()
+		if pageBlock, ok := c.pageBlocks[page]; ok {
+			if err := pageBlock.mergeBlocks(block); err != nil {
+				return err
+			}
+			if err := mergeResources(block.resources, pageBlock.resources); err != nil {
+				return err
+			}
+		} else {
+			c.pageBlocks[page] = block
 		}
 	}