build.go

package generator

import (
	"fmt"
	"time"

	"github.com/go-pdf/fpdf"
)

// Build pdf document from data provided
func (doc *Document) Build() (*fpdf.Fpdf, error) {
	// Validate document data
	if err := doc.Validate(); err != nil {
		return nil, err
	}

	// Build base doc
	doc.pdf.SetMargins(BaseMargin, BaseMarginTop, BaseMargin)
	doc.pdf.SetXY(10, 10)
	doc.pdf.SetTextColor(
		doc.Options.BaseTextColor[0],
		doc.Options.BaseTextColor[1],
		doc.Options.BaseTextColor[2],
	)

	// Set header
	if doc.Header != nil {
		if err := doc.Header.applyHeader(doc); err != nil {
			return nil, err
		}
	}

	// Set footer
	if doc.Footer != nil {
		if err := doc.Footer.applyFooter(doc); err != nil {
			return nil, err
		}
	}

	// Add first page
	doc.pdf.AddPage()

	// Load font
	doc.pdf.SetFont(doc.Options.Font, "", 12)

	// Appenf document title
	doc.appendTitle()

	// Appenf document metas (ref & version)
	doc.appendMetas()

	// Append company contact to doc
	companyBottom := doc.Company.appendCompanyContactToDoc(doc)

	// Append customer contact to doc
	customerBottom := doc.Customer.appendCustomerContactToDoc(doc)

	if customerBottom > companyBottom {
		doc.pdf.SetXY(10, customerBottom)
	} else {
		doc.pdf.SetXY(10, companyBottom)
	}

	// Append description
	doc.appendDescription()

	// Append items
	doc.appendItems()

	// Check page height (total bloc height = 30, 45 when doc discount)
	offset := doc.pdf.GetY() + 30
	if doc.Discount != nil {
		offset += 15
	}
	if offset > MaxPageHeight {
		doc.pdf.AddPage()
	}

	// Append notes
	doc.appendNotes()

	// Append total
	doc.appendTotal()

	// Append payment term
	doc.appendPaymentTerm()

	// Append js to autoprint if AutoPrint == true
	if doc.Options.AutoPrint {
		doc.pdf.SetJavascript("print(true);")
	}

	return doc.pdf, nil
}

// appendTitle to document
func (doc *Document) appendTitle() {
	title := doc.typeAsString()

	// Set x y
	doc.pdf.SetXY(120, BaseMarginTop)

	// Draw rect
	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
	doc.pdf.Rect(120, BaseMarginTop, 80, 10, "F")

	// Draw text
	doc.pdf.SetFont(doc.Options.Font, "", 14)
	doc.pdf.CellFormat(80, 10, doc.encodeString(title), "0", 0, "C", false, 0, "")
}

// appendMetas to document
func (doc *Document) appendMetas() {
	// Append ref
	refString := fmt.Sprintf("%s: %s", doc.Options.TextRefTitle, doc.Ref)

	doc.pdf.SetXY(120, BaseMarginTop+11)
	doc.pdf.SetFont(doc.Options.Font, "", 8)
	doc.pdf.CellFormat(80, 4, doc.encodeString(refString), "0", 0, "R", false, 0, "")

	// Append version
	if len(doc.Version) > 0 {
		versionString := fmt.Sprintf("%s: %s", doc.Options.TextVersionTitle, doc.Version)
		doc.pdf.SetXY(120, BaseMarginTop+15)
		doc.pdf.SetFont(doc.Options.Font, "", 8)
		doc.pdf.CellFormat(80, 4, doc.encodeString(versionString), "0", 0, "R", false, 0, "")
	}

	// Append date
	date := time.Now().Format("02/01/2006")
	if len(doc.Date) > 0 {
		date = doc.Date
	}
	dateString := fmt.Sprintf("%s: %s", doc.Options.TextDateTitle, date)
	doc.pdf.SetXY(120, BaseMarginTop+19)
	doc.pdf.SetFont(doc.Options.Font, "", 8)
	doc.pdf.CellFormat(80, 4, doc.encodeString(dateString), "0", 0, "R", false, 0, "")
}

// appendDescription to document
func (doc *Document) appendDescription() {
	if len(doc.Description) > 0 {
		doc.pdf.SetY(doc.pdf.GetY() + 10)
		doc.pdf.SetFont(doc.Options.Font, "", 10)
		doc.pdf.MultiCell(190, 5, doc.encodeString(doc.Description), "B", "L", false)
	}
}

// drawsTableTitles in document
func (doc *Document) drawsTableTitles() {
	// Draw table titles
	doc.pdf.SetX(10)
	doc.pdf.SetY(doc.pdf.GetY() + 5)
	doc.pdf.SetFont(doc.Options.BoldFont, "B", 8)

	// Draw rec
	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
	doc.pdf.Rect(10, doc.pdf.GetY(), 190, 6, "F")

	// Name
	doc.pdf.SetX(ItemColNameOffset)
	doc.pdf.CellFormat(
		ItemColUnitPriceOffset-ItemColNameOffset,
		6,
		doc.encodeString(doc.Options.TextItemsNameTitle),
		"0",
		0,
		"",
		false,
		0,
		"",
	)

	// Unit price
	doc.pdf.SetX(ItemColUnitPriceOffset)
	doc.pdf.CellFormat(
		ItemColQuantityOffset-ItemColUnitPriceOffset,
		6,
		doc.encodeString(doc.Options.TextItemsUnitCostTitle),
		"0",
		0,
		"",
		false,
		0,
		"",
	)

	// Quantity
	doc.pdf.SetX(ItemColQuantityOffset)
	doc.pdf.CellFormat(
		ItemColTaxOffset-ItemColQuantityOffset,
		6,
		doc.encodeString(doc.Options.TextItemsQuantityTitle),
		"0",
		0,
		"",
		false,
		0,
		"",
	)

	// Total HT
	doc.pdf.SetX(ItemColTotalHTOffset)
	doc.pdf.CellFormat(
		ItemColTaxOffset-ItemColTotalHTOffset,
		6,
		doc.encodeString(doc.Options.TextItemsTotalHTTitle),
		"0",
		0,
		"",
		false,
		0,
		"",
	)
}

// appendItems to document
func (doc *Document) appendItems() {
	doc.drawsTableTitles()

	doc.pdf.SetX(10)
	doc.pdf.SetY(doc.pdf.GetY() + 8)
	doc.pdf.SetFont(doc.Options.Font, "", 8)

	for i := 0; i < len(doc.Items); i++ {
		item := doc.Items[i]

		// Check item tax
		if item.Tax == nil {
			item.Tax = doc.DefaultTax
		}

		// Append to pdf
		item.appendColTo(doc.Options, doc)

		if doc.pdf.GetY() > MaxPageHeight {
			// Add page
			doc.pdf.AddPage()
			doc.drawsTableTitles()
			doc.pdf.SetFont(doc.Options.Font, "", 8)
		}

		doc.pdf.SetX(10)
		doc.pdf.SetY(doc.pdf.GetY() + 6)
	}
}

// appendNotes to document
func (doc *Document) appendNotes() {
	if len(doc.Notes) == 0 {
		return
	}

	currentY := doc.pdf.GetY()

	doc.pdf.SetFont(doc.Options.Font, "", 9)
	doc.pdf.SetX(BaseMargin)
	doc.pdf.SetRightMargin(100)
	doc.pdf.SetY(currentY + 10)

	_, lineHt := doc.pdf.GetFontSize()
	html := doc.pdf.HTMLBasicNew()
	html.Write(lineHt, doc.encodeString(doc.Notes))

	doc.pdf.SetRightMargin(BaseMargin)
	doc.pdf.SetY(currentY)
}

// appendTotal to document
func (doc *Document) appendTotal() {
	doc.pdf.SetY(doc.pdf.GetY() + 10)
	doc.pdf.SetFont(doc.Options.Font, "", LargeTextFontSize)
	doc.pdf.SetTextColor(
		doc.Options.BaseTextColor[0],
		doc.Options.BaseTextColor[1],
		doc.Options.BaseTextColor[2],
	)

	// Draw TOTAL HT title
	doc.pdf.SetX(120)
	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
	doc.pdf.Rect(120, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(38, 10, doc.encodeString("SUBTOTAL"), "0", 0, "R", false, 0, "")

	// Draw TOTAL HT amount
	doc.pdf.SetX(162)
	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(
		40,
		10,
		doc.encodeString(doc.CustomSubtotal),
		"0",
		0,
		"L",
		false,
		0,
		"",
	)

	doc.pdf.SetY(doc.pdf.GetY() + 10)

	// Draw tax title
	doc.pdf.SetX(120)
	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
	doc.pdf.Rect(120, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(38, 10, doc.encodeString("TAX (" + doc.CustomTaxRate + ")"), "0", 0, "R", false, 0, "")

	// Draw tax amount
	doc.pdf.SetX(162)
	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(
		40,
		10,
		doc.encodeString(doc.CustomTax),
		"0",
		0,
		"L",
		false,
		0,
		"",
	)

	// Draw total with tax title
	doc.pdf.SetY(doc.pdf.GetY() + 10)
	doc.pdf.SetX(120)
	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
	doc.pdf.Rect(120, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(38, 10, doc.encodeString("TOTAL"), "0", 0, "R", false, 0, "")

	// Draw total with tax amount
	doc.pdf.SetX(162)
	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
	doc.pdf.CellFormat(
		40,
		10,
		doc.encodeString(doc.CustomTotal),
		"0",
		0,
		"L",
		false,
		0,
		"",
	)
}

// appendPaymentTerm to document
func (doc *Document) appendPaymentTerm() {
	if len(doc.PaymentTerm) > 0 {
		paymentTermString := fmt.Sprintf(
			"%s: %s",
			doc.encodeString(doc.Options.TextPaymentTermTitle),
			doc.encodeString(doc.PaymentTerm),
		)
		doc.pdf.SetY(doc.pdf.GetY() + 15)

		doc.pdf.SetX(120)
		doc.pdf.SetFont(doc.Options.BoldFont, "B", 10)
		doc.pdf.CellFormat(80, 4, doc.encodeString(paymentTermString), "0", 0, "R", false, 0, "")
	}
}