go-docx/docxlib.go

package docxlib

import (
	"archive/zip"
	"bytes"
	"io"
	"io/fs"
)

// Docx is the structure that allow to access the internal represntation
// in memory of the doc (either read or about to be written)
type Docx struct {
	Document    Document
	DocRelation Relationships

	media        []Media
	mediaNameIdx map[string]int

	rId     uintptr
	imageId uintptr

	template string
	tmplfs   fs.FS
	tmpfslst []string

	buf        *bytes.Buffer
	isbufempty bool

	io.Reader
	io.WriterTo
}

// NewA4 generates a new empty A4 docx file that we can manipulate and
// later on, save
func NewA4() *Docx {
	return newEmptyA4File()
}

// Parse generates a new docx file in memory from a reader
// You can it invoke from a file
//
//	readFile, err := os.Open(FILE_PATH)
//	if err != nil {
//		panic(err)
//	}
//	fileinfo, err := readFile.Stat()
//	if err != nil {
//		panic(err)
//	}
//	size := fileinfo.Size()
//	doc, err := docxlib.Parse(readFile, int64(size))
//
// but also you can invoke from a webform (BEWARE of trusting users data!!!)
//
//	func uploadFile(w http.ResponseWriter, r *http.Request) {
//		r.ParseMultipartForm(10 << 20)
//
//		file, handler, err := r.FormFile("file")
//		if err != nil {
//			fmt.Println("Error Retrieving the File")
//			fmt.Println(err)
//			http.Error(w, err.Error(), http.StatusBadRequest)
//			return
//		}
//		defer file.Close()
//		docxlib.Parse(file, handler.Size)
//	}
func Parse(reader io.ReaderAt, size int64) (doc *Docx, err error) {
	zipReader, err := zip.NewReader(reader, size)
	if err != nil {
		return nil, err
	}
	doc, err = unpack(zipReader)
	return
}

// Write allows to save a docx to a writer
func (f *Docx) WriteTo(writer io.Writer) (_ int64, err error) {
	zipWriter := zip.NewWriter(writer)
	defer zipWriter.Close()

	return 0, f.pack(zipWriter)
}

// Read allows to save a docx to buf
func (f *Docx) Read(p []byte) (n int, err error) {
	if !f.isbufempty {
		n, err = f.buf.Read(p)
		if err == io.EOF {
			f.buf.Reset()
			f.isbufempty = true
			return
		}
	}
	zipWriter := zip.NewWriter(f.buf)
	defer zipWriter.Close()
	f.isbufempty = false
	return f.buf.Read(p)
}