forked from tealeg/xlsx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.go
1128 lines (1004 loc) · 29.8 KB
/
lib.go
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package xlsx
import (
"archive/zip"
"bytes"
"encoding/xml"
"errors"
"fmt"
"io"
"path"
"path/filepath"
"runtime/debug"
"strconv"
"strings"
)
const (
sheetEnding = `</sheetData></worksheet>`
fixedCellRefChar = "$"
cellRangeChar = ":"
externalSheetBangChar = "!"
)
// XLSXReaderError is the standard error type for otherwise undefined
// errors in the XSLX reading process.
type XLSXReaderError struct {
Err string
}
// Error returns a string value from an XLSXReaderError struct in order
// that it might comply with the builtin.error interface.
func (e *XLSXReaderError) Error() string {
return e.Err
}
// getRangeFromString is an internal helper function that converts
// XLSX internal range syntax to a pair of integers. For example,
// the range string "1:3" yield the upper and lower integers 1 and 3.
func getRangeFromString(rangeString string) (lower int, upper int, error error) {
var parts []string
parts = strings.SplitN(rangeString, cellRangeChar, 2)
if parts[0] == "" {
error = errors.New(fmt.Sprintf("Invalid range '%s'\n", rangeString))
}
if parts[1] == "" {
error = errors.New(fmt.Sprintf("Invalid range '%s'\n", rangeString))
}
lower, error = strconv.Atoi(parts[0])
if error != nil {
error = errors.New(fmt.Sprintf("Invalid range (not integer in lower bound) %s\n", rangeString))
}
upper, error = strconv.Atoi(parts[1])
if error != nil {
error = errors.New(fmt.Sprintf("Invalid range (not integer in upper bound) %s\n", rangeString))
}
return lower, upper, error
}
// ColLettersToIndex is used to convert a character based column
// reference to a zero based numeric column identifier.
func ColLettersToIndex(letters string) int {
sum, mul, n := 0, 1, 0
for i := len(letters) - 1; i >= 0; i, mul, n = i-1, mul*26, 1 {
c := letters[i]
switch {
case 'A' <= c && c <= 'Z':
n += int(c - 'A')
case 'a' <= c && c <= 'z':
n += int(c - 'a')
}
sum += n * mul
}
return sum
}
// ColIndexToLetters is used to convert a zero based, numeric column
// indentifier into a character code.
func ColIndexToLetters(n int) string {
// taken from https://github.com/psmithuk/xlsx/blob/master/xlsx.go
var s string
n += 1
for n > 0 {
n -= 1
l := n%26
s = string('A'+rune(l)) + s
n /= 26
}
return s
}
// RowIndexToString is used to convert a zero based, numeric row
// indentifier into its string representation.
func RowIndexToString(rowRef int) string {
return strconv.Itoa(rowRef + 1)
}
// letterOnlyMapF is used in conjunction with strings.Map to return
// only the characters A-Z and a-z in a string
func letterOnlyMapF(rune rune) rune {
switch {
case 'A' <= rune && rune <= 'Z':
return rune
case 'a' <= rune && rune <= 'z':
return rune - 32
}
return -1
}
// intOnlyMapF is used in conjunction with strings.Map to return only
// the numeric portions of a string.
func intOnlyMapF(rune rune) rune {
if rune >= 48 && rune < 58 {
return rune
}
return -1
}
// GetCoordsFromCellIDString returns the zero based cartesian
// coordinates from a cell name in Excel format, e.g. the cellIDString
// "A1" returns 0, 0 and the "B3" return 1, 2.
func GetCoordsFromCellIDString(cellIDString string) (x, y int, err error) {
wrap := func(err error) (int, int, error) {
return -1, -1, fmt.Errorf("GetCoordsFromCellIdString(%q): %w", cellIDString, err)
}
var letterPart string = strings.Map(letterOnlyMapF, cellIDString)
y, err = strconv.Atoi(strings.Map(intOnlyMapF, cellIDString))
if err != nil {
return wrap(err)
}
y -= 1 // Zero based
x = ColLettersToIndex(letterPart)
return x, y, nil
}
// GetCellIDStringFromCoords returns the Excel format cell name that
// represents a pair of zero based cartesian coordinates.
func GetCellIDStringFromCoords(x, y int) string {
return GetCellIDStringFromCoordsWithFixed(x, y, false, false)
}
// GetCellIDStringFromCoordsWithFixed returns the Excel format cell name that
// represents a pair of zero based cartesian coordinates.
// It can specify either value as fixed.
func GetCellIDStringFromCoordsWithFixed(x, y int, xFixed, yFixed bool) string {
xStr := ColIndexToLetters(x)
if xFixed {
xStr = fixedCellRefChar + xStr
}
yStr := RowIndexToString(y)
if yFixed {
yStr = fixedCellRefChar + yStr
}
return xStr + yStr
}
// getMaxMinFromDimensionRef return the zero based cartesian maximum
// and minimum coordinates from the dimension reference embedded in a
// XLSX worksheet. For example, the dimension reference "A1:B2"
// returns "0,0", "1,1".
func getMaxMinFromDimensionRef(ref string) (minx, miny, maxx, maxy int, err error) {
var parts []string
wrap := func(err error) (int, int, int, int, error) {
return -1, -1, -1, -1, fmt.Errorf("getMaxMinFromDimensionRef: %w", err)
}
parts = strings.Split(ref, cellRangeChar)
minx, miny, err = GetCoordsFromCellIDString(parts[0])
if err != nil {
return wrap(err)
}
maxx, maxy, err = GetCoordsFromCellIDString(parts[1])
if err != nil {
return wrap(err)
}
return
}
// calculateMaxMinFromWorkSheet works out the dimensions of a spreadsheet
// that doesn't have a DimensionRef set. The only case currently
// known where this is true is with XLSX exported from Google Docs.
func calculateMaxMinFromWorksheet(worksheet *xlsxWorksheet) (minx, miny, maxx, maxy int, err error) {
// Note, this method could be very slow for large spreadsheets.
var x, y int
var maxVal int
wrap := func(err error) (int, int, int, int, error) {
return -1, -1, -1, -1, fmt.Errorf("calculateMaxMinFromWorksheet: %w", err)
}
maxVal = int(^uint(0) >> 1)
minx = maxVal
miny = maxVal
maxy = 0
maxx = 0
for _, row := range worksheet.SheetData.Row {
for _, cell := range row.C {
x, y, err = GetCoordsFromCellIDString(cell.R)
if err != nil {
return wrap(err)
}
if x < minx {
minx = x
}
if x > maxx {
maxx = x
}
if y < miny {
miny = y
}
if y > maxy {
maxy = y
}
}
}
if minx == maxVal {
minx = 0
}
if miny == maxVal {
miny = 0
}
return
}
// makeRowFromSpan will, when given a span expressed as a string,
// return an empty Row large enough to encompass that span and
// populate it with empty cells. All rows start from cell 1 -
// regardless of the lower bound of the span.
func makeRowFromSpan(spans string, sheet *Sheet) *Row {
_, upper, err := getRangeFromString(spans)
if err != nil {
panic(err)
}
row := sheet.cellStore.MakeRowWithLen(sheet, upper)
return row
}
// makeRowFromRaw returns the Row representation of the xlsxRow.
func makeRowFromRaw(rawrow xlsxRow, sheet *Sheet) *Row {
var upper int
upper = -1
for _, rawcell := range rawrow.C {
if rawcell.R != "" {
x, _, error := GetCoordsFromCellIDString(rawcell.R)
if error != nil {
panic(fmt.Sprintf("Invalid Cell Coord, %s\n", rawcell.R))
}
if x > upper {
upper = x
}
continue
}
upper++
}
upper++
row := sheet.cellStore.MakeRowWithLen(sheet, upper)
row.SetOutlineLevel(rawrow.OutlineLevel)
return row
}
func makeEmptyRow(sheet *Sheet) *Row {
row := new(Row)
row.Sheet = sheet
return row
}
type sharedFormula struct {
x, y int
formula string
}
func formulaForCell(rawcell xlsxC, sharedFormulas map[int]sharedFormula) string {
var res string
f := rawcell.F
if f == nil {
return ""
}
if f.T == "shared" {
x, y, err := GetCoordsFromCellIDString(rawcell.R)
if err != nil {
res = f.Content
} else {
if f.Ref != "" {
res = f.Content
sharedFormulas[f.Si] = sharedFormula{x, y, res}
} else {
sharedFormula := sharedFormulas[f.Si]
dx := x - sharedFormula.x
dy := y - sharedFormula.y
orig := []byte(sharedFormula.formula)
var start, end int
var stringLiteral bool
for end = 0; end < len(orig); end++ {
c := orig[end]
if c == '"' {
stringLiteral = !stringLiteral
}
if stringLiteral {
continue // Skip characters in quotes
}
if c >= 'A' && c <= 'Z' || c == '$' {
res += string(orig[start:end])
start = end
end++
foundNum := false
for ; end < len(orig); end++ {
idc := orig[end]
if idc >= '0' && idc <= '9' || idc == '$' {
foundNum = true
} else if idc >= 'A' && idc <= 'Z' {
if foundNum {
break
}
} else {
break
}
}
if foundNum {
cellID := string(orig[start:end])
res += shiftCell(cellID, dx, dy)
start = end
}
}
}
if start < len(orig) {
res += string(orig[start:])
}
}
}
} else {
res = f.Content
}
return strings.Trim(res, " \t\n\r")
}
// shiftCell returns the cell shifted according to dx and dy taking into consideration of absolute
// references with dollar sign ($)
func shiftCell(cellID string, dx, dy int) string {
fx, fy, _ := GetCoordsFromCellIDString(cellID)
// Is fixed column?
fixedCol := strings.Index(cellID, fixedCellRefChar) == 0
// Is fixed row?
fixedRow := strings.LastIndex(cellID, fixedCellRefChar) > 0
if !fixedCol {
// Shift column
fx += dx
}
if !fixedRow {
// Shift row
fy += dy
}
// New shifted cell
shiftedCellID := GetCellIDStringFromCoords(fx, fy)
if !fixedCol && !fixedRow {
return shiftedCellID
}
// There are absolute references, need to put the $ back into the formula.
letterPart := strings.Map(letterOnlyMapF, shiftedCellID)
numberPart := strings.Map(intOnlyMapF, shiftedCellID)
result := ""
if fixedCol {
result += "$"
}
result += letterPart
if fixedRow {
result += "$"
}
result += numberPart
return result
}
// fillCellData attempts to extract a valid value, usable in
// CSV form from the raw cell value. Note - this is not actually
// general enough - we should support retaining tabs and newlines.
func fillCellData(rawCell xlsxC, refTable *RefTable, sharedFormulas map[int]sharedFormula, cell *Cell) {
val := strings.Trim(rawCell.V, " \t\n\r")
cell.formula = formulaForCell(rawCell, sharedFormulas)
switch rawCell.T {
case "s": // Shared String
cell.cellType = CellTypeString
if val != "" {
ref, err := strconv.Atoi(val)
if err != nil {
panic(err)
}
cell.Value, cell.RichText = refTable.ResolveSharedString(ref)
}
case "inlineStr":
cell.cellType = CellTypeInline
fillCellDataFromInlineString(rawCell, cell)
case "b": // Boolean
cell.Value = val
cell.cellType = CellTypeBool
case "e": // Error
cell.Value = val
cell.cellType = CellTypeError
case "str":
// String Formula (special type for cells with formulas that return a string value)
// Unlike the other string cell types, the string is stored directly in the value.
cell.Value = val
cell.cellType = CellTypeStringFormula
case "d": // Date: Cell contains a date in the ISO 8601 format.
cell.Value = val
cell.cellType = CellTypeDate
case "": // Numeric is the default
fallthrough
case "n": // Numeric
cell.Value = val
cell.cellType = CellTypeNumeric
default:
panic(errors.New("invalid cell type"))
}
cell.origValue = cell.Value
cell.origRichText = cell.RichText
cell.modified = false
}
// fillCellDataFromInlineString attempts to get inline string data and put it into a Cell.
func fillCellDataFromInlineString(rawcell xlsxC, cell *Cell) {
cell.Value = ""
cell.RichText = nil
if rawcell.Is != nil {
if rawcell.Is.T != nil {
cell.Value = strings.Trim(rawcell.Is.T.getText(), " \t\n\r")
} else {
cell.RichText = xmlToRichText(rawcell.Is.R)
}
}
cell.origValue = cell.Value
cell.origRichText = cell.RichText
cell.modified = false
}
// readRowsFromSheet is an internal helper function that extracts the
// rows from a XSLXWorksheet, populates them with Cells and resolves
// the value references from the reference table and stores them in
// the rows and columns.
func readRowsFromSheet(Worksheet *xlsxWorksheet, file *File, sheet *Sheet, rowLimit int, linkTable hyperlinkTable) error {
var row *Row
var maxCol, maxRow, colCount, rowCount int
var reftable *RefTable
var err error
var insertRowIndex int // , insertColIndex int
sharedFormulas := map[int]sharedFormula{}
wrap := func(err error) error {
return fmt.Errorf("readRowsFromSheet: %w", err)
}
if len(Worksheet.SheetData.Row) == 0 {
sheet.MaxRow = 0
sheet.MaxCol = 0
return nil
}
reftable = file.referenceTable
if len(Worksheet.Dimension.Ref) > 0 && len(strings.Split(Worksheet.Dimension.Ref, cellRangeChar)) == 2 && rowLimit == NoRowLimit {
_, _, maxCol, maxRow, err = getMaxMinFromDimensionRef(Worksheet.Dimension.Ref)
} else {
_, _, maxCol, maxRow, err = calculateMaxMinFromWorksheet(Worksheet)
}
if err != nil {
return wrap(err)
}
rowCount = maxRow + 1
colCount = maxCol + 1
if Worksheet.Cols != nil {
// Columns can apply to a range, for convenience we expand the
// ranges out into individual column definitions.
for _, rawcol := range Worksheet.Cols.Col {
col := &Col{
Hidden: rawcol.Hidden,
Width: rawcol.Width,
Min: rawcol.Min,
Max: rawcol.Max,
OutlineLevel: rawcol.OutlineLevel,
BestFit: rawcol.BestFit,
CustomWidth: rawcol.CustomWidth,
Phonetic: rawcol.Phonetic,
Collapsed: rawcol.Collapsed,
}
if file.styles != nil {
if rawcol.Style != nil && *rawcol.Style > 0 {
col.style = file.styles.getStyle(*rawcol.Style)
col.numFmt, col.parsedNumFmt = file.styles.getNumberFormat(*rawcol.Style)
}
}
sheet.Cols.Add(col)
}
}
for rowIndex := 0; rowIndex < len(Worksheet.SheetData.Row); rowIndex++ {
rawrow := Worksheet.SheetData.Row[rowIndex]
// range is not empty and only one range exist
if len(rawrow.Spans) != 0 && strings.Count(rawrow.Spans, cellRangeChar) == 1 {
row = makeRowFromSpan(rawrow.Spans, sheet)
} else {
row = makeRowFromRaw(rawrow, sheet)
}
sheet.setCurrentRow(row)
row.num = rawrow.R - 1
row.Hidden = rawrow.Hidden
height, err := strconv.ParseFloat(rawrow.Ht, 64)
if err == nil {
row.SetHeight(height)
}
row.isCustom = rawrow.CustomHeight
row.SetOutlineLevel(rawrow.OutlineLevel)
for _, rawcell := range rawrow.C {
if rawcell.R == "" {
continue
}
h, v, err := Worksheet.MergeCells.getExtent(rawcell.R)
if err != nil {
return wrap(err)
}
x, y, err := GetCoordsFromCellIDString(rawcell.R)
if err != nil {
return wrap(err)
}
cellX := x
cell := newCell(row, cellX)
row.PushCell(cell)
cell.HMerge = h
cell.VMerge = v
fillCellData(rawcell, reftable, sharedFormulas, cell)
if file.styles != nil {
cell.SetStyle(file.styles.getStyle(rawcell.S))
cell.NumFmt, cell.parsedNumFmt = file.styles.getNumberFormat(rawcell.S)
}
cell.date1904 = file.Date1904
if hyperlink, found := linkTable[coord{x: x, y: y}]; found {
cell.Hyperlink = hyperlink
}
// Cell is considered hidden if the row or the column of this cell is hidden
col := sheet.Cols.FindColByIndex(cellX + 1)
cell.Hidden = rawrow.Hidden || (col != nil && col.Hidden != nil && *col.Hidden)
cell.modified = true
}
sheet.cellStore.WriteRow(row)
insertRowIndex++
}
sheet.MaxRow = rowCount
sheet.MaxCol = colCount
if rowCount >= 0 {
row, err = sheet.Row(0)
if err != nil {
return wrap(err)
}
sheet.setCurrentRow(row)
}
return nil
}
type indexedSheet struct {
Index int
Sheet *Sheet
Error error
}
func readSheetViews(xSheetViews xlsxSheetViews) []SheetView {
if xSheetViews.SheetView == nil || len(xSheetViews.SheetView) == 0 {
return nil
}
sheetViews := []SheetView{}
for _, xSheetView := range xSheetViews.SheetView {
sheetView := SheetView{}
if xSheetView.Pane != nil {
xlsxPane := xSheetView.Pane
pane := &Pane{}
pane.XSplit = xlsxPane.XSplit
pane.YSplit = xlsxPane.YSplit
pane.TopLeftCell = xlsxPane.TopLeftCell
pane.ActivePane = xlsxPane.ActivePane
pane.State = xlsxPane.State
sheetView.Pane = pane
}
sheetViews = append(sheetViews, sheetView)
}
return sheetViews
}
type coord struct {
x int
y int
}
type hyperlinkTable map[coord]Hyperlink
func makeHyperlinkTable(worksheet *xlsxWorksheet, fi *File, rsheet *xlsxSheet) (hyperlinkTable, error) {
wrap := func(err error) (hyperlinkTable, error) {
return nil, fmt.Errorf("makeHyperlinkTable: %w", err)
}
table := make(hyperlinkTable)
// Convert xlsxHyperlinks to Hyperlinks
if worksheet.Hyperlinks != nil {
worksheetRelsFile, ok := fi.worksheetRels["sheet"+rsheet.SheetId]
worksheetRels := new(xlsxWorksheetRels)
if ok {
rc, err := worksheetRelsFile.Open()
if err != nil {
return wrap(fmt.Errorf("file.Open: %w", err))
}
decoder := xml.NewDecoder(rc)
err = decoder.Decode(worksheetRels)
if err != nil {
return wrap(fmt.Errorf("xml.Decoder.Decode: %w", err))
}
}
for _, xlsxLink := range worksheet.Hyperlinks.HyperLinks {
newHyperLink := Hyperlink{}
for _, rel := range worksheetRels.Relationships {
if rel.Id == xlsxLink.RelationshipId {
newHyperLink.Link = rel.Target
break
}
}
if xlsxLink.Tooltip != "" {
newHyperLink.Tooltip = xlsxLink.Tooltip
}
if xlsxLink.DisplayString != "" {
newHyperLink.DisplayString = xlsxLink.DisplayString
}
if xlsxLink.Location != "" {
newHyperLink.Location = xlsxLink.Location
}
cellRef := xlsxLink.Reference
x, y, err := GetCoordsFromCellIDString(cellRef)
if err != nil {
return wrap(err)
}
table[coord{x: x, y: y}] = newHyperLink
}
// row, err := sheet.Row(y)
// if err != nil {
// return wrap(err)
// }
// fmt.Printf("%d, %d, %+v\n", x, y, row)
// // cell := row.GetCell(x)
// // cell.Hyperlink = newHyperLink
// }
}
return table, nil
}
// readSheetFromFile is the logic of converting a xlsxSheet struct
// into a Sheet struct. This work can be done in parallel and so
// readSheetsFromZipFile will spawn an instance of this function per
// sheet and get the results back on the provided channel.
func readSheetFromFile(rsheet xlsxSheet, fi *File, sheetXMLMap map[string]string, rowLimit int) (sheet *Sheet, errRes error) {
defer func() {
if x := recover(); x != nil {
errRes = errors.New(fmt.Sprintf("%v\n%s\n", x, debug.Stack()))
}
}()
wrap := func(err error) (*Sheet, error) {
return nil, fmt.Errorf("readSheetFromFile: %w", err)
}
worksheet, err := getWorksheetFromSheet(rsheet, fi.worksheets, sheetXMLMap, rowLimit)
if err != nil {
return wrap(err)
}
linkTable, err := makeHyperlinkTable(worksheet, fi, &rsheet)
if err != nil {
return wrap(err)
}
sheet, err = NewSheetWithCellStore(rsheet.Name, fi.cellStoreConstructor)
if err != nil {
return wrap(err)
}
sheet.File = fi
err = readRowsFromSheet(worksheet, fi, sheet, rowLimit, linkTable)
if err != nil {
return wrap(err)
}
sheet.Hidden = rsheet.State == sheetStateHidden || rsheet.State == sheetStateVeryHidden
sheet.SheetViews = readSheetViews(worksheet.SheetViews)
if worksheet.AutoFilter != nil {
autoFilterBounds := strings.Split(worksheet.AutoFilter.Ref, ":")
sheet.AutoFilter = &AutoFilter{autoFilterBounds[0], autoFilterBounds[1]}
}
sheet.SheetFormat.DefaultColWidth = worksheet.SheetFormatPr.DefaultColWidth
sheet.SheetFormat.DefaultRowHeight = worksheet.SheetFormatPr.DefaultRowHeight
sheet.SheetFormat.OutlineLevelCol = worksheet.SheetFormatPr.OutlineLevelCol
sheet.SheetFormat.OutlineLevelRow = worksheet.SheetFormatPr.OutlineLevelRow
if nil != worksheet.DataValidations {
for _, dd := range worksheet.DataValidations.DataValidation {
sheet.AddDataValidation(dd)
}
}
return sheet, nil
}
// readSheetsFromZipFile is an internal helper function that loops
// over the Worksheets defined in the XSLXWorkbook and loads them into
// Sheet objects stored in the Sheets slice of a xlsx.File struct.
func readSheetsFromZipFile(f *zip.File, file *File, sheetXMLMap map[string]string, rowLimit int) (map[string]*Sheet, []*Sheet, error) {
var workbook *xlsxWorkbook
var err error
var rc io.ReadCloser
var decoder *xml.Decoder
var sheetCount int
wrap := func(err error) (map[string]*Sheet, []*Sheet, error) {
return nil, nil, fmt.Errorf("readSheetsFromZipFile: %w", err)
}
workbook = new(xlsxWorkbook)
rc, err = f.Open()
if err != nil {
return wrap(fmt.Errorf("file.Open: %w", err))
}
decoder = xml.NewDecoder(rc)
err = decoder.Decode(workbook)
if err != nil {
return wrap(fmt.Errorf("xml.Decoder.Decode: %w", err))
}
file.Date1904 = workbook.WorkbookPr.Date1904
for entryNum := range workbook.DefinedNames.DefinedName {
file.DefinedNames = append(file.DefinedNames, &workbook.DefinedNames.DefinedName[entryNum])
}
// Only try and read sheets that have corresponding files.
// Notably this excludes chartsheets don't right now
var workbookSheets []xlsxSheet
for _, sheet := range workbook.Sheets.Sheet {
if f := worksheetFileForSheet(sheet, file.worksheets, sheetXMLMap); f != nil {
workbookSheets = append(workbookSheets, sheet)
}
}
sheetCount = len(workbookSheets)
sheetsByName := make(map[string]*Sheet, sheetCount)
sheets := make([]*Sheet, sheetCount)
sheetChan := make(chan *indexedSheet, sheetCount)
for i, rawsheet := range workbookSheets {
i, rawsheet := i, rawsheet
go func() {
sheet, err := readSheetFromFile(rawsheet, file,
sheetXMLMap, rowLimit)
sheetChan <- &indexedSheet{
Index: i,
Sheet: sheet,
Error: err,
}
}()
}
for j := 0; j < sheetCount; j++ {
sheet := <-sheetChan
if sheet == nil {
return wrap(fmt.Errorf("No sheet returnded from readSheetFromFile"))
}
if sheet.Error != nil {
return wrap(sheet.Error)
}
sheetName := sheet.Sheet.Name
sheetsByName[sheetName] = sheet.Sheet
sheets[sheet.Index] = sheet.Sheet
}
return sheetsByName, sheets, nil
}
// readSharedStringsFromZipFile() is an internal helper function to
// extract a reference table from the sharedStrings.xml file within
// the XLSX zip file.
func readSharedStringsFromZipFile(f *zip.File) (*RefTable, error) {
var sst *xlsxSST
var err error
var rc io.ReadCloser
var decoder *xml.Decoder
var reftable *RefTable
wrap := func(err error) (*RefTable, error) {
return nil, fmt.Errorf("readSharedStringsFromZipFile: %w", err)
}
// In a file with no strings it's possible that
// sharedStrings.xml doesn't exist. In this case the value
// passed as f will be nil.
if f == nil {
return nil, nil
}
rc, err = f.Open()
if err != nil {
return wrap(err)
}
sst = new(xlsxSST)
decoder = xml.NewDecoder(rc)
err = decoder.Decode(sst)
if err != nil {
return wrap(err)
}
reftable = MakeSharedStringRefTable(sst)
return reftable, nil
}
// readStylesFromZipFile() is an internal helper function to
// extract a style table from the style.xml file within
// the XLSX zip file.
func readStylesFromZipFile(f *zip.File, theme *theme) (*xlsxStyleSheet, error) {
var style *xlsxStyleSheet
var err error
var rc io.ReadCloser
var decoder *xml.Decoder
wrap := func(err error) (*xlsxStyleSheet, error) {
return nil, fmt.Errorf("readStylesFromZipFile: %w", err)
}
rc, err = f.Open()
if err != nil {
return wrap(err)
}
style = newXlsxStyleSheet(theme)
decoder = xml.NewDecoder(rc)
err = decoder.Decode(style)
if err != nil {
return wrap(err)
}
buildNumFmtRefTable(style)
return style, nil
}
func buildNumFmtRefTable(style *xlsxStyleSheet) {
if style.NumFmts != nil {
for _, numFmt := range style.NumFmts.NumFmt {
// We do this for the side effect of populating the NumFmtRefTable.
style.addNumFmt(numFmt)
}
}
}
func readThemeFromZipFile(f *zip.File) (*theme, error) {
wrap := func(err error) (*theme, error) {
return nil, fmt.Errorf("readThemeFromZipFile: %w", err)
}
rc, err := f.Open()
if err != nil {
return wrap(err)
}
var themeXml xlsxTheme
err = xml.NewDecoder(rc).Decode(&themeXml)
if err != nil {
return wrap(err)
}
return newTheme(themeXml), nil
}
type WorkBookRels map[string]string
func (w *WorkBookRels) MakeXLSXWorkbookRels() xlsxWorkbookRels {
relCount := len(*w)
xWorkbookRels := xlsxWorkbookRels{}
xWorkbookRels.Relationships = make([]xlsxWorkbookRelation, relCount+3)
for k, v := range *w {
index, err := strconv.Atoi(k[3:])
if err != nil {
panic(err.Error())
}
xWorkbookRels.Relationships[index-1] = xlsxWorkbookRelation{
Id: k,
Target: v,
Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"}
}
relCount++
sheetId := fmt.Sprintf("rId%d", relCount)
xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
Id: sheetId,
Target: "sharedStrings.xml",
Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"}
relCount++
sheetId = fmt.Sprintf("rId%d", relCount)
xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
Id: sheetId,
Target: "theme/theme1.xml",
Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"}
relCount++
sheetId = fmt.Sprintf("rId%d", relCount)
xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
Id: sheetId,
Target: "styles.xml",
Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"}
return xWorkbookRels
}
// readWorkbookRelationsFromZipFile is an internal helper function to
// extract a map of relationship ID strings to the name of the
// worksheet.xml file they refer to. The resulting map can be used to
// reliably derefence the worksheets in the XLSX file.
func readWorkbookRelationsFromZipFile(workbookRels *zip.File) (WorkBookRels, error) {
var sheetXMLMap WorkBookRels
var wbRelationships *xlsxWorkbookRels
var rc io.ReadCloser
var decoder *xml.Decoder
var err error
wrap := func(err error) (WorkBookRels, error) {
return nil, fmt.Errorf("readWorkbookRelationsFromZipFile :%w", err)
}
rc, err = workbookRels.Open()
if err != nil {
return wrap(err)
}
decoder = xml.NewDecoder(rc)
wbRelationships = new(xlsxWorkbookRels)
err = decoder.Decode(wbRelationships)
if err != nil {
return wrap(err)
}
sheetXMLMap = make(WorkBookRels)
for _, rel := range wbRelationships.Relationships {
if strings.HasSuffix(rel.Target, ".xml") && rel.Type == "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" {
_, filename := path.Split(rel.Target)
sheetXMLMap[rel.Id] = strings.Replace(filename, ".xml", "", 1)
}
}
return sheetXMLMap, nil
}
// ReadZip() takes a pointer to a zip.ReadCloser and returns a
// xlsx.File struct populated with its contents. In most cases
// ReadZip is not used directly, but is called internally by OpenFile.
func ReadZip(f *zip.ReadCloser, options ...FileOption) (*File, error) {
defer f.Close()
file, err := ReadZipReader(&f.Reader, options...)
if err != nil {
return nil, fmt.Errorf("ReadZip: %w", err)
}
return file, nil
}
// ReadZipReader() can be used to read an XLSX in memory without
// touching the filesystem.
func ReadZipReader(r *zip.Reader, options ...FileOption) (*File, error) {
var err error
var file *File
var reftable *RefTable
var sharedStrings *zip.File
var sheetXMLMap map[string]string
var sheetsByName map[string]*Sheet
var sheets []*Sheet
var style *xlsxStyleSheet