lib.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903
  1. package xlsx
  2. import (
  3. "archive/zip"
  4. "encoding/xml"
  5. "errors"
  6. "fmt"
  7. "io"
  8. "path"
  9. "strconv"
  10. "strings"
  11. )
  12. // XLSXReaderError is the standard error type for otherwise undefined
  13. // errors in the XSLX reading process.
  14. type XLSXReaderError struct {
  15. Err string
  16. }
  17. // Error returns a string value from an XLSXReaderError struct in order
  18. // that it might comply with the builtin.error interface.
  19. func (e *XLSXReaderError) Error() string {
  20. return e.Err
  21. }
  22. // getRangeFromString is an internal helper function that converts
  23. // XLSX internal range syntax to a pair of integers. For example,
  24. // the range string "1:3" yield the upper and lower intergers 1 and 3.
  25. func getRangeFromString(rangeString string) (lower int, upper int, error error) {
  26. var parts []string
  27. parts = strings.SplitN(rangeString, ":", 2)
  28. if parts[0] == "" {
  29. error = errors.New(fmt.Sprintf("Invalid range '%s'\n", rangeString))
  30. }
  31. if parts[1] == "" {
  32. error = errors.New(fmt.Sprintf("Invalid range '%s'\n", rangeString))
  33. }
  34. lower, error = strconv.Atoi(parts[0])
  35. if error != nil {
  36. error = errors.New(fmt.Sprintf("Invalid range (not integer in lower bound) %s\n", rangeString))
  37. }
  38. upper, error = strconv.Atoi(parts[1])
  39. if error != nil {
  40. error = errors.New(fmt.Sprintf("Invalid range (not integer in upper bound) %s\n", rangeString))
  41. }
  42. return lower, upper, error
  43. }
  44. // lettersToNumeric is used to convert a character based column
  45. // reference to a zero based numeric column identifier.
  46. func lettersToNumeric(letters string) int {
  47. sum, mul, n := 0, 1, 0
  48. for i := len(letters) - 1; i >= 0; i, mul, n = i-1, mul*26, 1 {
  49. c := letters[i]
  50. switch {
  51. case 'A' <= c && c <= 'Z':
  52. n += int(c - 'A')
  53. case 'a' <= c && c <= 'z':
  54. n += int(c - 'a')
  55. }
  56. sum += n * mul
  57. }
  58. return sum
  59. }
  60. // Get the largestDenominator that is a multiple of a basedDenominator
  61. // and fits at least once into a given numerator.
  62. func getLargestDenominator(numerator, multiple, baseDenominator, power int) (int, int) {
  63. if numerator/multiple == 0 {
  64. return 1, power
  65. }
  66. next, nextPower := getLargestDenominator(
  67. numerator, multiple*baseDenominator, baseDenominator, power+1)
  68. if next > multiple {
  69. return next, nextPower
  70. }
  71. return multiple, power
  72. }
  73. // Convers a list of numbers representing a column into a alphabetic
  74. // representation, as used in the spreadsheet.
  75. func formatColumnName(colId []int) string {
  76. lastPart := len(colId) - 1
  77. result := ""
  78. for n, part := range colId {
  79. if n == lastPart {
  80. // The least significant number is in the
  81. // range 0-25, all other numbers are 1-26,
  82. // hence we use a differente offset for the
  83. // last part.
  84. result += string(part + 65)
  85. } else {
  86. // Don't output leading 0s, as there is no
  87. // representation of 0 in this format.
  88. if part > 0 {
  89. result += string(part + 64)
  90. }
  91. }
  92. }
  93. return result
  94. }
  95. func smooshBase26Slice(b26 []int) []int {
  96. // Smoosh values together, eliminating 0s from all but the
  97. // least significant part.
  98. lastButOnePart := len(b26) - 2
  99. for i := lastButOnePart; i > 0; i-- {
  100. part := b26[i]
  101. if part == 0 {
  102. greaterPart := b26[i-1]
  103. if greaterPart > 0 {
  104. b26[i-1] = greaterPart - 1
  105. b26[i] = 26
  106. }
  107. }
  108. }
  109. return b26
  110. }
  111. func intToBase26(x int) (parts []int) {
  112. // Excel column codes are pure evil - in essence they're just
  113. // base26, but they don't represent the number 0.
  114. b26Denominator, _ := getLargestDenominator(x, 1, 26, 0)
  115. // This loop terminates because integer division of 1 / 26
  116. // returns 0.
  117. for d := b26Denominator; d > 0; d = d / 26 {
  118. value := x / d
  119. remainder := x % d
  120. parts = append(parts, value)
  121. x = remainder
  122. }
  123. return parts
  124. }
  125. // numericToLetters is used to convert a zero based, numeric column
  126. // indentifier into a character code.
  127. func numericToLetters(colRef int) string {
  128. parts := intToBase26(colRef)
  129. return formatColumnName(smooshBase26Slice(parts))
  130. }
  131. // letterOnlyMapF is used in conjunction with strings.Map to return
  132. // only the characters A-Z and a-z in a string
  133. func letterOnlyMapF(rune rune) rune {
  134. switch {
  135. case 'A' <= rune && rune <= 'Z':
  136. return rune
  137. case 'a' <= rune && rune <= 'z':
  138. return rune - 32
  139. }
  140. return -1
  141. }
  142. // intOnlyMapF is used in conjunction with strings.Map to return only
  143. // the numeric portions of a string.
  144. func intOnlyMapF(rune rune) rune {
  145. if rune >= 48 && rune < 58 {
  146. return rune
  147. }
  148. return -1
  149. }
  150. // getCoordsFromCellIDString returns the zero based cartesian
  151. // coordinates from a cell name in Excel format, e.g. the cellIDString
  152. // "A1" returns 0, 0 and the "B3" return 1, 2.
  153. func getCoordsFromCellIDString(cellIDString string) (x, y int, error error) {
  154. var letterPart string = strings.Map(letterOnlyMapF, cellIDString)
  155. y, error = strconv.Atoi(strings.Map(intOnlyMapF, cellIDString))
  156. if error != nil {
  157. return x, y, error
  158. }
  159. y -= 1 // Zero based
  160. x = lettersToNumeric(letterPart)
  161. return x, y, error
  162. }
  163. // getCellIDStringFromCoords returns the Excel format cell name that
  164. // represents a pair of zero based cartesian coordinates.
  165. func getCellIDStringFromCoords(x, y int) string {
  166. letterPart := numericToLetters(x)
  167. numericPart := y + 1
  168. return fmt.Sprintf("%s%d", letterPart, numericPart)
  169. }
  170. // getMaxMinFromDimensionRef return the zero based cartesian maximum
  171. // and minimum coordinates from the dimension reference embedded in a
  172. // XLSX worksheet. For example, the dimension reference "A1:B2"
  173. // returns "0,0", "1,1".
  174. func getMaxMinFromDimensionRef(ref string) (minx, miny, maxx, maxy int, err error) {
  175. var parts []string
  176. parts = strings.Split(ref, ":")
  177. minx, miny, err = getCoordsFromCellIDString(parts[0])
  178. if err != nil {
  179. return -1, -1, -1, -1, err
  180. }
  181. if len(parts) == 1 {
  182. maxx, maxy = minx, miny
  183. return
  184. }
  185. maxx, maxy, err = getCoordsFromCellIDString(parts[1])
  186. if err != nil {
  187. return -1, -1, -1, -1, err
  188. }
  189. return
  190. }
  191. // calculateMaxMinFromWorkSheet works out the dimensions of a spreadsheet
  192. // that doesn't have a DimensionRef set. The only case currently
  193. // known where this is true is with XLSX exported from Google Docs.
  194. func calculateMaxMinFromWorksheet(worksheet *xlsxWorksheet) (minx, miny, maxx, maxy int, err error) {
  195. // Note, this method could be very slow for large spreadsheets.
  196. var x, y int
  197. var maxVal int
  198. maxVal = int(^uint(0) >> 1)
  199. minx = maxVal
  200. miny = maxVal
  201. maxy = 0
  202. maxx = 0
  203. for _, row := range worksheet.SheetData.Row {
  204. for _, cell := range row.C {
  205. x, y, err = getCoordsFromCellIDString(cell.R)
  206. if err != nil {
  207. return -1, -1, -1, -1, err
  208. }
  209. if x < minx {
  210. minx = x
  211. }
  212. if x > maxx {
  213. maxx = x
  214. }
  215. if y < miny {
  216. miny = y
  217. }
  218. if y > maxy {
  219. maxy = y
  220. }
  221. }
  222. }
  223. if minx == maxVal {
  224. minx = 0
  225. }
  226. if miny == maxVal {
  227. miny = 0
  228. }
  229. return
  230. }
  231. // makeRowFromSpan will, when given a span expressed as a string,
  232. // return an empty Row large enough to encompass that span and
  233. // populate it with empty cells. All rows start from cell 1 -
  234. // regardless of the lower bound of the span.
  235. func makeRowFromSpan(spans string, sheet *Sheet) *Row {
  236. var error error
  237. var upper int
  238. var row *Row
  239. var cell *Cell
  240. row = new(Row)
  241. row.Sheet = sheet
  242. _, upper, error = getRangeFromString(spans)
  243. if error != nil {
  244. panic(error)
  245. }
  246. error = nil
  247. row.Cells = make([]*Cell, upper)
  248. for i := 0; i < upper; i++ {
  249. cell = new(Cell)
  250. cell.Value = ""
  251. row.Cells[i] = cell
  252. }
  253. return row
  254. }
  255. // makeRowFromRaw returns the Row representation of the xlsxRow.
  256. func makeRowFromRaw(rawrow xlsxRow, sheet *Sheet) *Row {
  257. var upper int
  258. var row *Row
  259. var cell *Cell
  260. row = new(Row)
  261. row.Sheet = sheet
  262. upper = -1
  263. for _, rawcell := range rawrow.C {
  264. if rawcell.R != "" {
  265. x, _, error := getCoordsFromCellIDString(rawcell.R)
  266. if error != nil {
  267. panic(fmt.Sprintf("Invalid Cell Coord, %s\n", rawcell.R))
  268. }
  269. if x > upper {
  270. upper = x
  271. }
  272. continue
  273. }
  274. upper++
  275. }
  276. upper++
  277. row.Cells = make([]*Cell, upper)
  278. for i := 0; i < upper; i++ {
  279. cell = new(Cell)
  280. cell.Value = ""
  281. row.Cells[i] = cell
  282. }
  283. return row
  284. }
  285. func makeEmptyRow(sheet *Sheet) *Row {
  286. row := new(Row)
  287. row.Cells = make([]*Cell, 0)
  288. row.Sheet = sheet
  289. return row
  290. }
  291. type sharedFormula struct {
  292. x, y int
  293. formula string
  294. }
  295. func formulaForCell(rawcell xlsxC, sharedFormulas map[int]sharedFormula) string {
  296. var res string
  297. f := rawcell.F
  298. if f == nil {
  299. return ""
  300. }
  301. if f.T == "shared" {
  302. x, y, err := getCoordsFromCellIDString(rawcell.R)
  303. if err != nil {
  304. res = f.Content
  305. } else {
  306. if f.Ref != "" {
  307. res = f.Content
  308. sharedFormulas[f.Si] = sharedFormula{x, y, res}
  309. } else {
  310. sharedFormula := sharedFormulas[f.Si]
  311. dx := x - sharedFormula.x
  312. dy := y - sharedFormula.y
  313. orig := []byte(sharedFormula.formula)
  314. var start, end int
  315. for end = 0; end < len(orig); end++ {
  316. c := orig[end]
  317. if c >= 'A' && c <= 'Z' {
  318. res += string(orig[start:end])
  319. start = end
  320. end++
  321. foundNum := false
  322. for ; end < len(orig); end++ {
  323. idc := orig[end]
  324. if idc >= '0' && idc <= '9' {
  325. foundNum = true
  326. } else if idc >= 'A' && idc <= 'Z' {
  327. if foundNum {
  328. break
  329. }
  330. } else {
  331. break
  332. }
  333. }
  334. if foundNum {
  335. fx, fy, _ := getCoordsFromCellIDString(string(orig[start:end]))
  336. fx += dx
  337. fy += dy
  338. res += getCellIDStringFromCoords(fx, fy)
  339. start = end
  340. }
  341. }
  342. }
  343. if start < len(orig) {
  344. res += string(orig[start:end])
  345. }
  346. }
  347. }
  348. } else {
  349. res = f.Content
  350. }
  351. return strings.Trim(res, " \t\n\r")
  352. }
  353. // fillCellData attempts to extract a valid value, usable in
  354. // CSV form from the raw cell value. Note - this is not actually
  355. // general enough - we should support retaining tabs and newlines.
  356. func fillCellData(rawcell xlsxC, reftable *RefTable, sharedFormulas map[int]sharedFormula, cell *Cell) {
  357. var data string = rawcell.V
  358. if len(data) > 0 {
  359. vval := strings.Trim(data, " \t\n\r")
  360. switch rawcell.T {
  361. case "s": // Shared String
  362. ref, error := strconv.Atoi(vval)
  363. if error != nil {
  364. panic(error)
  365. }
  366. cell.Value = reftable.ResolveSharedString(ref)
  367. cell.cellType = CellTypeString
  368. case "b": // Boolean
  369. cell.Value = vval
  370. cell.cellType = CellTypeBool
  371. case "e": // Error
  372. cell.Value = vval
  373. cell.formula = formulaForCell(rawcell, sharedFormulas)
  374. cell.cellType = CellTypeError
  375. default:
  376. if rawcell.F == nil {
  377. // Numeric
  378. cell.Value = vval
  379. cell.cellType = CellTypeNumeric
  380. } else {
  381. // Formula
  382. cell.Value = vval
  383. cell.formula = formulaForCell(rawcell, sharedFormulas)
  384. cell.cellType = CellTypeFormula
  385. }
  386. }
  387. }
  388. }
  389. // readRowsFromSheet is an internal helper function that extracts the
  390. // rows from a XSLXWorksheet, populates them with Cells and resolves
  391. // the value references from the reference table and stores them in
  392. // the rows and columns.
  393. func readRowsFromSheet(Worksheet *xlsxWorksheet, file *File, sheet *Sheet) ([]*Row, []*Col, int, int) {
  394. var rows []*Row
  395. var cols []*Col
  396. var row *Row
  397. var minCol, maxCol, minRow, maxRow, colCount, rowCount int
  398. var reftable *RefTable
  399. var err error
  400. var insertRowIndex, insertColIndex int
  401. sharedFormulas := map[int]sharedFormula{}
  402. if len(Worksheet.SheetData.Row) == 0 {
  403. return nil, nil, 0, 0
  404. }
  405. reftable = file.referenceTable
  406. if len(Worksheet.Dimension.Ref) > 0 {
  407. minCol, minRow, maxCol, maxRow, err = getMaxMinFromDimensionRef(Worksheet.Dimension.Ref)
  408. } else {
  409. minCol, minRow, maxCol, maxRow, err = calculateMaxMinFromWorksheet(Worksheet)
  410. }
  411. if err != nil {
  412. panic(err.Error())
  413. }
  414. rowCount = maxRow + 1
  415. colCount = maxCol + 1
  416. rows = make([]*Row, rowCount)
  417. cols = make([]*Col, colCount)
  418. insertRowIndex = minRow
  419. for i := range cols {
  420. cols[i] = &Col{
  421. Hidden: false,
  422. }
  423. }
  424. if Worksheet.Cols != nil {
  425. // Columns can apply to a range, for convenience we expand the
  426. // ranges out into individual column definitions.
  427. for _, rawcol := range Worksheet.Cols.Col {
  428. // Note, below, that sometimes column definitions can
  429. // exist outside the defined dimensions of the
  430. // spreadsheet - we deliberately exclude these
  431. // columns.
  432. for i := rawcol.Min; i <= rawcol.Max && i <= colCount; i++ {
  433. col := &Col{
  434. Min: rawcol.Min,
  435. Max: rawcol.Max,
  436. Hidden: rawcol.Hidden,
  437. Width: rawcol.Width}
  438. cols[i-1] = col
  439. if file.styles != nil {
  440. col.style = file.styles.getStyle(rawcol.Style)
  441. col.numFmt = file.styles.getNumberFormat(rawcol.Style)
  442. }
  443. }
  444. }
  445. }
  446. // insert leading empty rows that is in front of minRow
  447. for rowIndex := 0; rowIndex < minRow; rowIndex++ {
  448. rows[rowIndex] = makeEmptyRow(sheet)
  449. }
  450. numRows := len(rows)
  451. for rowIndex := 0; rowIndex < len(Worksheet.SheetData.Row); rowIndex++ {
  452. rawrow := Worksheet.SheetData.Row[rowIndex]
  453. // Some spreadsheets will omit blank rows from the
  454. // stored data
  455. for rawrow.R > (insertRowIndex + 1) {
  456. // Put an empty Row into the array
  457. if insertRowIndex < numRows {
  458. rows[insertRowIndex] = makeEmptyRow(sheet)
  459. }
  460. insertRowIndex++
  461. }
  462. // range is not empty and only one range exist
  463. if len(rawrow.Spans) != 0 && strings.Count(rawrow.Spans, ":") == 1 {
  464. row = makeRowFromSpan(rawrow.Spans, sheet)
  465. } else {
  466. row = makeRowFromRaw(rawrow, sheet)
  467. }
  468. row.Hidden = rawrow.Hidden
  469. insertColIndex = minCol
  470. for _, rawcell := range rawrow.C {
  471. h, v, err := Worksheet.MergeCells.getExtent(rawcell.R)
  472. if err != nil {
  473. panic(err.Error())
  474. }
  475. x, _, _ := getCoordsFromCellIDString(rawcell.R)
  476. // Some spreadsheets will omit blank cells
  477. // from the data.
  478. for x > insertColIndex {
  479. // Put an empty Cell into the array
  480. row.Cells[insertColIndex] = new(Cell)
  481. insertColIndex++
  482. }
  483. cellX := insertColIndex
  484. cell := row.Cells[cellX]
  485. cell.HMerge = h
  486. cell.VMerge = v
  487. fillCellData(rawcell, reftable, sharedFormulas, cell)
  488. if file.styles != nil {
  489. cell.style = file.styles.getStyle(rawcell.S)
  490. cell.NumFmt = file.styles.getNumberFormat(rawcell.S)
  491. }
  492. cell.date1904 = file.Date1904
  493. // Cell is considered hidden if the row or the column of this cell is hidden
  494. cell.Hidden = rawrow.Hidden || (len(cols) > cellX && cols[cellX].Hidden)
  495. insertColIndex++
  496. }
  497. if len(rows) > insertRowIndex {
  498. rows[insertRowIndex] = row
  499. }
  500. insertRowIndex++
  501. }
  502. return rows, cols, colCount, rowCount
  503. }
  504. type indexedSheet struct {
  505. Index int
  506. Sheet *Sheet
  507. Error error
  508. }
  509. func readSheetViews(xSheetViews xlsxSheetViews) []SheetView {
  510. if xSheetViews.SheetView == nil || len(xSheetViews.SheetView) == 0 {
  511. return nil
  512. }
  513. sheetViews := []SheetView{}
  514. for _, xSheetView := range xSheetViews.SheetView {
  515. sheetView := SheetView{}
  516. if xSheetView.Pane != nil {
  517. xlsxPane := xSheetView.Pane
  518. pane := &Pane{}
  519. pane.XSplit = xlsxPane.XSplit
  520. pane.YSplit = xlsxPane.YSplit
  521. pane.TopLeftCell = xlsxPane.TopLeftCell
  522. pane.ActivePane = xlsxPane.ActivePane
  523. pane.State = xlsxPane.State
  524. sheetView.Pane = pane
  525. }
  526. sheetViews = append(sheetViews, sheetView)
  527. }
  528. return sheetViews
  529. }
  530. // readSheetFromFile is the logic of converting a xlsxSheet struct
  531. // into a Sheet struct. This work can be done in parallel and so
  532. // readSheetsFromZipFile will spawn an instance of this function per
  533. // sheet and get the results back on the provided channel.
  534. func readSheetFromFile(sc chan *indexedSheet, index int, rsheet xlsxSheet, fi *File, sheetXMLMap map[string]string) {
  535. result := &indexedSheet{Index: index, Sheet: nil, Error: nil}
  536. defer func() {
  537. if e := recover(); e != nil {
  538. switch e.(type) {
  539. case error:
  540. result.Error = e.(error)
  541. default:
  542. result.Error = errors.New("unexpected error")
  543. }
  544. // The only thing here, is if one close the channel. but its not the case
  545. sc <- result
  546. }
  547. }()
  548. worksheet, error := getWorksheetFromSheet(rsheet, fi.worksheets, sheetXMLMap)
  549. if error != nil {
  550. result.Error = error
  551. sc <- result
  552. return
  553. }
  554. sheet := new(Sheet)
  555. sheet.File = fi
  556. sheet.Rows, sheet.Cols, sheet.MaxCol, sheet.MaxRow = readRowsFromSheet(worksheet, fi, sheet)
  557. sheet.Hidden = rsheet.State == sheetStateHidden || rsheet.State == sheetStateVeryHidden
  558. sheet.SheetViews = readSheetViews(worksheet.SheetViews)
  559. sheet.SheetFormat.DefaultColWidth = worksheet.SheetFormatPr.DefaultColWidth
  560. sheet.SheetFormat.DefaultRowHeight = worksheet.SheetFormatPr.DefaultRowHeight
  561. result.Sheet = sheet
  562. sc <- result
  563. }
  564. // readSheetsFromZipFile is an internal helper function that loops
  565. // over the Worksheets defined in the XSLXWorkbook and loads them into
  566. // Sheet objects stored in the Sheets slice of a xlsx.File struct.
  567. func readSheetsFromZipFile(f *zip.File, file *File, sheetXMLMap map[string]string) (map[string]*Sheet, []*Sheet, error) {
  568. var workbook *xlsxWorkbook
  569. var err error
  570. var rc io.ReadCloser
  571. var decoder *xml.Decoder
  572. var sheetCount int
  573. workbook = new(xlsxWorkbook)
  574. rc, err = f.Open()
  575. if err != nil {
  576. return nil, nil, err
  577. }
  578. decoder = xml.NewDecoder(rc)
  579. err = decoder.Decode(workbook)
  580. if err != nil {
  581. return nil, nil, err
  582. }
  583. file.Date1904 = workbook.WorkbookPr.Date1904
  584. // Only try and read sheets that have corresponding files.
  585. // Notably this excludes chartsheets don't right now
  586. var workbookSheets []xlsxSheet
  587. for _, sheet := range workbook.Sheets.Sheet {
  588. if f := worksheetFileForSheet(sheet, file.worksheets, sheetXMLMap); f != nil {
  589. workbookSheets = append(workbookSheets, sheet)
  590. }
  591. }
  592. sheetCount = len(workbookSheets)
  593. sheetsByName := make(map[string]*Sheet, sheetCount)
  594. sheets := make([]*Sheet, sheetCount)
  595. sheetChan := make(chan *indexedSheet, sheetCount)
  596. defer close(sheetChan)
  597. go func() {
  598. err = nil
  599. for i, rawsheet := range workbookSheets {
  600. readSheetFromFile(sheetChan, i, rawsheet, file, sheetXMLMap)
  601. }
  602. }()
  603. for j := 0; j < sheetCount; j++ {
  604. sheet := <-sheetChan
  605. if sheet.Error != nil {
  606. return nil, nil, sheet.Error
  607. }
  608. sheetName := workbookSheets[sheet.Index].Name
  609. sheetsByName[sheetName] = sheet.Sheet
  610. sheet.Sheet.Name = sheetName
  611. sheets[sheet.Index] = sheet.Sheet
  612. }
  613. return sheetsByName, sheets, nil
  614. }
  615. // readSharedStringsFromZipFile() is an internal helper function to
  616. // extract a reference table from the sharedStrings.xml file within
  617. // the XLSX zip file.
  618. func readSharedStringsFromZipFile(f *zip.File) (*RefTable, error) {
  619. var sst *xlsxSST
  620. var error error
  621. var rc io.ReadCloser
  622. var decoder *xml.Decoder
  623. var reftable *RefTable
  624. // In a file with no strings it's possible that
  625. // sharedStrings.xml doesn't exist. In this case the value
  626. // passed as f will be nil.
  627. if f == nil {
  628. return nil, nil
  629. }
  630. rc, error = f.Open()
  631. if error != nil {
  632. return nil, error
  633. }
  634. sst = new(xlsxSST)
  635. decoder = xml.NewDecoder(rc)
  636. error = decoder.Decode(sst)
  637. if error != nil {
  638. return nil, error
  639. }
  640. reftable = MakeSharedStringRefTable(sst)
  641. return reftable, nil
  642. }
  643. // readStylesFromZipFile() is an internal helper function to
  644. // extract a style table from the style.xml file within
  645. // the XLSX zip file.
  646. func readStylesFromZipFile(f *zip.File, theme *theme) (*xlsxStyleSheet, error) {
  647. var style *xlsxStyleSheet
  648. var error error
  649. var rc io.ReadCloser
  650. var decoder *xml.Decoder
  651. rc, error = f.Open()
  652. if error != nil {
  653. return nil, error
  654. }
  655. style = newXlsxStyleSheet(theme)
  656. decoder = xml.NewDecoder(rc)
  657. error = decoder.Decode(style)
  658. if error != nil {
  659. return nil, error
  660. }
  661. buildNumFmtRefTable(style)
  662. return style, nil
  663. }
  664. func buildNumFmtRefTable(style *xlsxStyleSheet) {
  665. for _, numFmt := range style.NumFmts.NumFmt {
  666. // We do this for the side effect of populating the NumFmtRefTable.
  667. style.addNumFmt(numFmt)
  668. }
  669. }
  670. func readThemeFromZipFile(f *zip.File) (*theme, error) {
  671. rc, err := f.Open()
  672. if err != nil {
  673. return nil, err
  674. }
  675. var themeXml xlsxTheme
  676. err = xml.NewDecoder(rc).Decode(&themeXml)
  677. if err != nil {
  678. return nil, err
  679. }
  680. return newTheme(themeXml), nil
  681. }
  682. type WorkBookRels map[string]string
  683. func (w *WorkBookRels) MakeXLSXWorkbookRels() xlsxWorkbookRels {
  684. relCount := len(*w)
  685. xWorkbookRels := xlsxWorkbookRels{}
  686. xWorkbookRels.Relationships = make([]xlsxWorkbookRelation, relCount+3)
  687. for k, v := range *w {
  688. index, err := strconv.Atoi(k[3:])
  689. if err != nil {
  690. panic(err.Error())
  691. }
  692. xWorkbookRels.Relationships[index-1] = xlsxWorkbookRelation{
  693. Id: k,
  694. Target: v,
  695. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"}
  696. }
  697. relCount++
  698. sheetId := fmt.Sprintf("rId%d", relCount)
  699. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  700. Id: sheetId,
  701. Target: "sharedStrings.xml",
  702. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"}
  703. relCount++
  704. sheetId = fmt.Sprintf("rId%d", relCount)
  705. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  706. Id: sheetId,
  707. Target: "theme/theme1.xml",
  708. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"}
  709. relCount++
  710. sheetId = fmt.Sprintf("rId%d", relCount)
  711. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  712. Id: sheetId,
  713. Target: "styles.xml",
  714. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"}
  715. return xWorkbookRels
  716. }
  717. // readWorkbookRelationsFromZipFile is an internal helper function to
  718. // extract a map of relationship ID strings to the name of the
  719. // worksheet.xml file they refer to. The resulting map can be used to
  720. // reliably derefence the worksheets in the XLSX file.
  721. func readWorkbookRelationsFromZipFile(workbookRels *zip.File) (WorkBookRels, error) {
  722. var sheetXMLMap WorkBookRels
  723. var wbRelationships *xlsxWorkbookRels
  724. var rc io.ReadCloser
  725. var decoder *xml.Decoder
  726. var err error
  727. rc, err = workbookRels.Open()
  728. if err != nil {
  729. return nil, err
  730. }
  731. decoder = xml.NewDecoder(rc)
  732. wbRelationships = new(xlsxWorkbookRels)
  733. err = decoder.Decode(wbRelationships)
  734. if err != nil {
  735. return nil, err
  736. }
  737. sheetXMLMap = make(WorkBookRels)
  738. for _, rel := range wbRelationships.Relationships {
  739. if strings.HasSuffix(rel.Target, ".xml") && rel.Type == "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" {
  740. _, filename := path.Split(rel.Target)
  741. sheetXMLMap[rel.Id] = strings.Replace(filename, ".xml", "", 1)
  742. }
  743. }
  744. return sheetXMLMap, nil
  745. }
  746. // ReadZip() takes a pointer to a zip.ReadCloser and returns a
  747. // xlsx.File struct populated with its contents. In most cases
  748. // ReadZip is not used directly, but is called internally by OpenFile.
  749. func ReadZip(f *zip.ReadCloser) (*File, error) {
  750. defer f.Close()
  751. return ReadZipReader(&f.Reader)
  752. }
  753. // ReadZipReader() can be used to read an XLSX in memory without
  754. // touching the filesystem.
  755. func ReadZipReader(r *zip.Reader) (*File, error) {
  756. var err error
  757. var file *File
  758. var reftable *RefTable
  759. var sharedStrings *zip.File
  760. var sheetXMLMap map[string]string
  761. var sheetsByName map[string]*Sheet
  762. var sheets []*Sheet
  763. var style *xlsxStyleSheet
  764. var styles *zip.File
  765. var themeFile *zip.File
  766. var v *zip.File
  767. var workbook *zip.File
  768. var workbookRels *zip.File
  769. var worksheets map[string]*zip.File
  770. file = NewFile()
  771. // file.numFmtRefTable = make(map[int]xlsxNumFmt, 1)
  772. worksheets = make(map[string]*zip.File, len(r.File))
  773. for _, v = range r.File {
  774. switch v.Name {
  775. case "xl/sharedStrings.xml":
  776. sharedStrings = v
  777. case "xl/workbook.xml":
  778. workbook = v
  779. case "xl/_rels/workbook.xml.rels":
  780. workbookRels = v
  781. case "xl/styles.xml":
  782. styles = v
  783. case "xl/theme/theme1.xml":
  784. themeFile = v
  785. default:
  786. if len(v.Name) > 14 {
  787. if v.Name[0:13] == "xl/worksheets" {
  788. worksheets[v.Name[14:len(v.Name)-4]] = v
  789. }
  790. }
  791. }
  792. }
  793. if workbookRels == nil {
  794. return nil, fmt.Errorf("xl/_rels/workbook.xml.rels not found in input xlsx.")
  795. }
  796. sheetXMLMap, err = readWorkbookRelationsFromZipFile(workbookRels)
  797. if err != nil {
  798. return nil, err
  799. }
  800. if len(worksheets) == 0 {
  801. return nil, fmt.Errorf("Input xlsx contains no worksheets.")
  802. }
  803. file.worksheets = worksheets
  804. reftable, err = readSharedStringsFromZipFile(sharedStrings)
  805. if err != nil {
  806. return nil, err
  807. }
  808. file.referenceTable = reftable
  809. if themeFile != nil {
  810. theme, err := readThemeFromZipFile(themeFile)
  811. if err != nil {
  812. return nil, err
  813. }
  814. file.theme = theme
  815. }
  816. if styles != nil {
  817. style, err = readStylesFromZipFile(styles, file.theme)
  818. if err != nil {
  819. return nil, err
  820. }
  821. file.styles = style
  822. }
  823. sheetsByName, sheets, err = readSheetsFromZipFile(workbook, file, sheetXMLMap)
  824. if err != nil {
  825. return nil, err
  826. }
  827. if sheets == nil {
  828. readerErr := new(XLSXReaderError)
  829. readerErr.Err = "No sheets found in XLSX File"
  830. return nil, readerErr
  831. }
  832. file.Sheet = sheetsByName
  833. file.Sheets = sheets
  834. return file, nil
  835. }