1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
|
package xlsx
import (
"archive/zip"
"encoding/xml"
"errors"
"io"
"strconv"
)
type StreamFile struct {
xlsxFile *File
sheetXmlPrefix []string
sheetXmlSuffix []string
zipWriter *zip.Writer
currentSheet *streamSheet
styleIds [][]int
styleIdMap map[StreamStyle]int
err error
}
type streamSheet struct {
// sheetIndex is the XLSX sheet index, which starts at 1
index int
// The number of rows that have been written to the sheet so far
rowCount int
// The number of columns in the sheet
columnCount int
// The writer to write to this sheet's file in the XLSX Zip file
writer io.Writer
styleIds []int
}
var (
NoCurrentSheetError = errors.New("no Current Sheet")
WrongNumberOfRowsError = errors.New("invalid number of cells passed to Write. All calls to Write on the same sheet must have the same number of cells")
AlreadyOnLastSheetError = errors.New("NextSheet() called, but already on last sheet")
UnsupportedCellTypeError = errors.New("the given cell type is not supported")
)
// Write will write a row of cells to the current sheet. Every call to Write on the same sheet must contain the
// same number of cells as the header provided when the sheet was created or an error will be returned. This function
// will always trigger a flush on success. Currently the only supported data type is string data.
func (sf *StreamFile) Write(cells []string) error {
if sf.err != nil {
return sf.err
}
err := sf.write(cells)
if err != nil {
sf.err = err
return err
}
return sf.zipWriter.Flush()
}
// WriteWithColumnDefaultMetadata will write a row of cells to the current sheet. Every call to WriteWithColumnDefaultMetadata
// on the same sheet must contain the same number of cells as the header provided when the sheet was created or
// an error will be returned. This function will always trigger a flush on success. Each cell will be encoded with the
// default CellMetadata of the column that it belongs to. However, if the cell data string cannot be
// parsed into the cell type in CellMetadata, we fall back on encoding the cell as a string and giving it a default
// string style
func (sf *StreamFile) WriteWithColumnDefaultMetadata(cells []string) error {
if sf.err != nil {
return sf.err
}
err := sf.writeWithColumnDefaultMetadata(cells)
if err != nil {
sf.err = err
return err
}
return sf.zipWriter.Flush()
}
// WriteS will write a row of cells to the current sheet. Every call to WriteS on the same sheet must
// contain the same number of cells as the number of columns provided when the sheet was created or an error
// will be returned. This function will always trigger a flush on success. WriteS supports all data types
// and styles that are supported by StreamCell.
func (sf *StreamFile) WriteS(cells []StreamCell) error {
if sf.err != nil {
return sf.err
}
err := sf.writeS(cells)
if err != nil {
sf.err = err
return err
}
return sf.zipWriter.Flush()
}
func (sf *StreamFile) WriteAll(records [][]string) error {
if sf.err != nil {
return sf.err
}
for _, row := range records {
err := sf.write(row)
if err != nil {
sf.err = err
return err
}
}
return sf.zipWriter.Flush()
}
// WriteAllS will write all the rows provided in records. All rows must have the same number of cells as
// the number of columns given when creating the sheet. This function will always trigger a flush on success.
// WriteAllS supports all data types and styles that are supported by StreamCell.
func (sf *StreamFile) WriteAllS(records [][]StreamCell) error {
if sf.err != nil {
return sf.err
}
for _, row := range records {
err := sf.writeS(row)
if err != nil {
sf.err = err
return err
}
}
return sf.zipWriter.Flush()
}
func (sf *StreamFile) write(cells []string) error {
if sf.currentSheet == nil {
return NoCurrentSheetError
}
if len(cells) != sf.currentSheet.columnCount {
return WrongNumberOfRowsError
}
sf.currentSheet.rowCount++
if err := sf.currentSheet.write(`<row r="` + strconv.Itoa(sf.currentSheet.rowCount) + `">`); err != nil {
return err
}
for colIndex, cellData := range cells {
// documentation for the c.t (cell.Type) attribute:
// b (Boolean): Cell containing a boolean.
// d (Date): Cell contains a date in the ISO 8601 format.
// e (Error): Cell containing an error.
// inlineStr (Inline String): Cell containing an (inline) rich string, i.e., one not in the shared string table.
// If this cell type is used, then the cell value is in the is element rather than the v element in the cell (c element).
// n (Number): Cell containing a number.
// s (Shared String): Cell containing a shared string.
// str (String): Cell containing a formula string.
cellCoordinate := GetCellIDStringFromCoords(colIndex, sf.currentSheet.rowCount-1)
cellType := "inlineStr"
cellOpen := `<c r="` + cellCoordinate + `" t="` + cellType + `"`
// Add in the style id if the cell isn't using the default style
if colIndex < len(sf.currentSheet.styleIds) && sf.currentSheet.styleIds[colIndex] != 0 {
cellOpen += ` s="` + strconv.Itoa(sf.currentSheet.styleIds[colIndex]) + `"`
}
cellOpen += `><is><t>`
cellClose := `</t></is></c>`
if err := sf.currentSheet.write(cellOpen); err != nil {
return err
}
if err := xml.EscapeText(sf.currentSheet.writer, []byte(cellData)); err != nil {
return err
}
if err := sf.currentSheet.write(cellClose); err != nil {
return err
}
}
if err := sf.currentSheet.write(`</row>`); err != nil {
return err
}
return sf.zipWriter.Flush()
}
func (sf *StreamFile) writeWithColumnDefaultMetadata(cells []string) error {
if sf.currentSheet == nil {
return NoCurrentSheetError
}
if len(cells) != sf.currentSheet.columnCount {
return WrongNumberOfRowsError
}
currentSheet := sf.xlsxFile.Sheets[sf.currentSheet.index-1]
var streamCells []StreamCell
for colIndex, col := range currentSheet.Cols {
// TODO: Legacy code paths like `StreamFileBuilder.AddSheet` could
// leave style empty and if cell data cannot be parsed into cell type then
// we need a sensible default StreamStyle to fall back to
style := StreamStyleDefaultString
// Because `cellData` could be anything we need to attempt to
// parse into the default cell type and if parsing fails fall back
// to some sensible default
defaultType := col.defaultCellType
// TODO: Again `CellType` could be nil if sheet was created through
// legacy code path so, like style, hardcoding for now
cellType := defaultType.fallbackTo(cells[colIndex], CellTypeString)
if defaultType != nil && *defaultType == cellType {
style = col.GetStreamStyle()
}
streamCells = append(
streamCells,
NewStreamCell(
cells[colIndex],
style,
cellType,
))
}
return sf.writeS(streamCells)
}
func (sf *StreamFile) writeS(cells []StreamCell) error {
if sf.currentSheet == nil {
return NoCurrentSheetError
}
if len(cells) != sf.currentSheet.columnCount {
return WrongNumberOfRowsError
}
sf.currentSheet.rowCount++
// Write the row opening
if err := sf.currentSheet.write(`<row r="` + strconv.Itoa(sf.currentSheet.rowCount) + `">`); err != nil {
return err
}
// Add cells one by one
for colIndex, cell := range cells {
xlsxCell, err := sf.getXlsxCell(cell, colIndex)
if err != nil {
return err
}
marshaledCell, err := xml.Marshal(xlsxCell)
if err != nil {
return nil
}
// Write the cell
if _, err := sf.currentSheet.writer.Write(marshaledCell); err != nil {
return err
}
}
// Write the row ending
if err := sf.currentSheet.write(`</row>`); err != nil {
return err
}
return sf.zipWriter.Flush()
}
func (sf *StreamFile) getXlsxCell(cell StreamCell, colIndex int) (xlsxC, error) {
// Get the cell reference (location)
cellCoordinate := GetCellIDStringFromCoords(colIndex, sf.currentSheet.rowCount-1)
var cellStyleId int
if cell.cellStyle != (StreamStyle{}) {
if idx, ok := sf.styleIdMap[cell.cellStyle]; ok {
cellStyleId = idx
} else {
return xlsxC{}, errors.New("trying to make use of a style that has not been added")
}
}
return makeXlsxCell(cell.cellType, cellCoordinate, cellStyleId, cell.cellData)
}
func makeXlsxCell(cellType CellType, cellCoordinate string, cellStyleId int, cellData string) (xlsxC, error) {
// documentation for the c.t (cell.Type) attribute:
// b (Boolean): Cell containing a boolean.
// d (Date): Cell contains a date in the ISO 8601 format.
// e (Error): Cell containing an error.
// inlineStr (Inline String): Cell containing an (inline) rich string, i.e., one not in the shared string table.
// If this cell type is used, then the cell value is in the is element rather than the v element in the cell (c element).
// n (Number): Cell containing a number.
// s (Shared String): Cell containing a shared string.
// str (String): Cell containing a formula string.
switch cellType {
case CellTypeBool:
return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "b", V: cellData}, nil
// Dates are better represented using CellTyleNumeric and the date formatting
//case CellTypeDate:
//return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "d", V: cellData}, nil
case CellTypeError:
return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "e", V: cellData}, nil
case CellTypeInline:
return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "inlineStr", Is: &xlsxSI{T: cellData}}, nil
case CellTypeNumeric:
return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "n", V: cellData}, nil
case CellTypeString:
// TODO Currently shared strings are types as inline strings
return xlsxC{XMLName: xml.Name{Local: "c"}, R: cellCoordinate, S: cellStyleId, T: "inlineStr", Is: &xlsxSI{T: cellData}}, nil
// TODO currently not supported
// case CellTypeStringFormula:
// return xlsxC{}, UnsupportedCellTypeError
default:
return xlsxC{}, UnsupportedCellTypeError
}
}
// Error reports any error that has occurred during a previous Write or Flush.
func (sf *StreamFile) Error() error {
return sf.err
}
func (sf *StreamFile) Flush() {
if sf.err != nil {
sf.err = sf.zipWriter.Flush()
}
}
// NextSheet will switch to the next sheet. Sheets are selected in the same order they were added.
// Once you leave a sheet, you cannot return to it.
func (sf *StreamFile) NextSheet() error {
if sf.err != nil {
return sf.err
}
var sheetIndex int
if sf.currentSheet != nil {
if sf.currentSheet.index >= len(sf.xlsxFile.Sheets) {
sf.err = AlreadyOnLastSheetError
return AlreadyOnLastSheetError
}
if err := sf.writeSheetEnd(); err != nil {
sf.currentSheet = nil
sf.err = err
return err
}
sheetIndex = sf.currentSheet.index
}
sheetIndex++
sf.currentSheet = &streamSheet{
index: sheetIndex,
columnCount: len(sf.xlsxFile.Sheets[sheetIndex-1].Cols),
styleIds: sf.styleIds[sheetIndex-1],
rowCount: len(sf.xlsxFile.Sheets[sheetIndex-1].Rows),
}
sheetPath := sheetFilePathPrefix + strconv.Itoa(sf.currentSheet.index) + sheetFilePathSuffix
fileWriter, err := sf.zipWriter.Create(sheetPath)
if err != nil {
sf.err = err
return err
}
sf.currentSheet.writer = fileWriter
if err := sf.writeSheetStart(); err != nil {
sf.err = err
return err
}
return nil
}
// Close closes the Stream File.
// Any sheets that have not yet been written to will have an empty sheet created for them.
func (sf *StreamFile) Close() error {
if sf.err != nil {
return sf.err
}
// If there are sheets that have not been written yet, call NextSheet() which will add files to the zip for them.
// XLSX readers may error if the sheets registered in the metadata are not present in the file.
if sf.currentSheet != nil {
for sf.currentSheet.index < len(sf.xlsxFile.Sheets) {
if err := sf.NextSheet(); err != nil {
sf.err = err
return err
}
}
// Write the end of the last sheet.
if err := sf.writeSheetEnd(); err != nil {
sf.err = err
return err
}
}
err := sf.zipWriter.Close()
if err != nil {
sf.err = err
}
return err
}
// writeSheetStart will write the start of the Sheet's XML
func (sf *StreamFile) writeSheetStart() error {
if sf.currentSheet == nil {
return NoCurrentSheetError
}
return sf.currentSheet.write(sf.sheetXmlPrefix[sf.currentSheet.index-1])
}
// writeSheetEnd will write the end of the Sheet's XML
func (sf *StreamFile) writeSheetEnd() error {
if sf.currentSheet == nil {
return NoCurrentSheetError
}
if err := sf.currentSheet.write(endSheetDataTag); err != nil {
return err
}
return sf.currentSheet.write(sf.sheetXmlSuffix[sf.currentSheet.index-1])
}
func (ss *streamSheet) write(data string) error {
_, err := ss.writer.Write([]byte(data))
return err
}
|