lib.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954
  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' || c == '$' {
  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' || idc == '$' {
  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. cellID := string(orig[start:end])
  336. res += shiftCell(cellID, dx, dy)
  337. start = end
  338. }
  339. }
  340. }
  341. if start < len(orig) {
  342. res += string(orig[start:end])
  343. }
  344. }
  345. }
  346. } else {
  347. res = f.Content
  348. }
  349. return strings.Trim(res, " \t\n\r")
  350. }
  351. // shiftCell returns the cell shifted according to dx and dy taking into consideration of absolute
  352. // references with dollar sign ($)
  353. func shiftCell(cellID string, dx, dy int) string {
  354. fx, fy, _ := getCoordsFromCellIDString(cellID)
  355. // Is fixed column?
  356. fixedCol := strings.Index(cellID, "$") == 0
  357. // Is fixed row?
  358. fixedRow := strings.LastIndex(cellID, "$") > 0
  359. if !fixedCol {
  360. // Shift column
  361. fx += dx
  362. }
  363. if !fixedRow {
  364. // Shift row
  365. fy += dy
  366. }
  367. // New shifted cell
  368. shiftedCellID := getCellIDStringFromCoords(fx, fy)
  369. if !fixedCol && !fixedRow {
  370. return shiftedCellID
  371. }
  372. // There are absolute references, need to put the $ back into the formula.
  373. letterPart := strings.Map(letterOnlyMapF, shiftedCellID)
  374. numberPart := strings.Map(intOnlyMapF, shiftedCellID)
  375. result := ""
  376. if fixedCol {
  377. result += "$"
  378. }
  379. result += letterPart
  380. if fixedRow {
  381. result += "$"
  382. }
  383. result += numberPart
  384. return result
  385. }
  386. // fillCellData attempts to extract a valid value, usable in
  387. // CSV form from the raw cell value. Note - this is not actually
  388. // general enough - we should support retaining tabs and newlines.
  389. func fillCellData(rawcell xlsxC, reftable *RefTable, sharedFormulas map[int]sharedFormula, cell *Cell) {
  390. var data string = rawcell.V
  391. if len(data) > 0 {
  392. vval := strings.Trim(data, " \t\n\r")
  393. switch rawcell.T {
  394. case "s": // Shared String
  395. ref, error := strconv.Atoi(vval)
  396. if error != nil {
  397. panic(error)
  398. }
  399. cell.Value = reftable.ResolveSharedString(ref)
  400. cell.cellType = CellTypeString
  401. case "b": // Boolean
  402. cell.Value = vval
  403. cell.cellType = CellTypeBool
  404. case "e": // Error
  405. cell.Value = vval
  406. cell.formula = formulaForCell(rawcell, sharedFormulas)
  407. cell.cellType = CellTypeError
  408. default:
  409. if rawcell.F == nil {
  410. // Numeric
  411. cell.Value = vval
  412. cell.cellType = CellTypeNumeric
  413. } else {
  414. // Formula
  415. cell.Value = vval
  416. cell.formula = formulaForCell(rawcell, sharedFormulas)
  417. cell.cellType = CellTypeFormula
  418. }
  419. }
  420. }
  421. }
  422. // readRowsFromSheet is an internal helper function that extracts the
  423. // rows from a XSLXWorksheet, populates them with Cells and resolves
  424. // the value references from the reference table and stores them in
  425. // the rows and columns.
  426. func readRowsFromSheet(Worksheet *xlsxWorksheet, file *File, sheet *Sheet) ([]*Row, []*Col, int, int) {
  427. var rows []*Row
  428. var cols []*Col
  429. var row *Row
  430. var minCol, maxCol, minRow, maxRow, colCount, rowCount int
  431. var reftable *RefTable
  432. var err error
  433. var insertRowIndex, insertColIndex int
  434. sharedFormulas := map[int]sharedFormula{}
  435. if len(Worksheet.SheetData.Row) == 0 {
  436. return nil, nil, 0, 0
  437. }
  438. reftable = file.referenceTable
  439. if len(Worksheet.Dimension.Ref) > 0 {
  440. minCol, minRow, maxCol, maxRow, err = getMaxMinFromDimensionRef(Worksheet.Dimension.Ref)
  441. } else {
  442. minCol, minRow, maxCol, maxRow, err = calculateMaxMinFromWorksheet(Worksheet)
  443. }
  444. if err != nil {
  445. panic(err.Error())
  446. }
  447. rowCount = maxRow + 1
  448. colCount = maxCol + 1
  449. rows = make([]*Row, rowCount)
  450. cols = make([]*Col, colCount)
  451. insertRowIndex = minRow
  452. for i := range cols {
  453. cols[i] = &Col{
  454. Hidden: false,
  455. }
  456. }
  457. if Worksheet.Cols != nil {
  458. // Columns can apply to a range, for convenience we expand the
  459. // ranges out into individual column definitions.
  460. for _, rawcol := range Worksheet.Cols.Col {
  461. // Note, below, that sometimes column definitions can
  462. // exist outside the defined dimensions of the
  463. // spreadsheet - we deliberately exclude these
  464. // columns.
  465. for i := rawcol.Min; i <= rawcol.Max && i <= colCount; i++ {
  466. col := &Col{
  467. Min: rawcol.Min,
  468. Max: rawcol.Max,
  469. Hidden: rawcol.Hidden,
  470. Width: rawcol.Width}
  471. cols[i-1] = col
  472. if file.styles != nil {
  473. col.style = file.styles.getStyle(rawcol.Style)
  474. col.numFmt = file.styles.getNumberFormat(rawcol.Style)
  475. }
  476. }
  477. }
  478. }
  479. // insert leading empty rows that is in front of minRow
  480. for rowIndex := 0; rowIndex < minRow; rowIndex++ {
  481. rows[rowIndex] = makeEmptyRow(sheet)
  482. }
  483. numRows := len(rows)
  484. for rowIndex := 0; rowIndex < len(Worksheet.SheetData.Row); rowIndex++ {
  485. rawrow := Worksheet.SheetData.Row[rowIndex]
  486. // Some spreadsheets will omit blank rows from the
  487. // stored data
  488. for rawrow.R > (insertRowIndex + 1) {
  489. // Put an empty Row into the array
  490. if insertRowIndex < numRows {
  491. rows[insertRowIndex] = makeEmptyRow(sheet)
  492. }
  493. insertRowIndex++
  494. }
  495. // range is not empty and only one range exist
  496. if len(rawrow.Spans) != 0 && strings.Count(rawrow.Spans, ":") == 1 {
  497. row = makeRowFromSpan(rawrow.Spans, sheet)
  498. } else {
  499. row = makeRowFromRaw(rawrow, sheet)
  500. }
  501. row.Hidden = rawrow.Hidden
  502. insertColIndex = minCol
  503. for _, rawcell := range rawrow.C {
  504. h, v, err := Worksheet.MergeCells.getExtent(rawcell.R)
  505. if err != nil {
  506. panic(err.Error())
  507. }
  508. x, _, _ := getCoordsFromCellIDString(rawcell.R)
  509. // Some spreadsheets will omit blank cells
  510. // from the data.
  511. for x > insertColIndex {
  512. // Put an empty Cell into the array
  513. row.Cells[insertColIndex] = new(Cell)
  514. insertColIndex++
  515. }
  516. cellX := insertColIndex
  517. cell := row.Cells[cellX]
  518. cell.HMerge = h
  519. cell.VMerge = v
  520. fillCellData(rawcell, reftable, sharedFormulas, cell)
  521. if file.styles != nil {
  522. cell.style = file.styles.getStyle(rawcell.S)
  523. cell.NumFmt = file.styles.getNumberFormat(rawcell.S)
  524. }
  525. cell.date1904 = file.Date1904
  526. // Cell is considered hidden if the row or the column of this cell is hidden
  527. cell.Hidden = rawrow.Hidden || (len(cols) > cellX && cols[cellX].Hidden)
  528. insertColIndex++
  529. }
  530. if len(rows) > insertRowIndex {
  531. rows[insertRowIndex] = row
  532. }
  533. insertRowIndex++
  534. }
  535. return rows, cols, colCount, rowCount
  536. }
  537. type indexedSheet struct {
  538. Index int
  539. Sheet *Sheet
  540. Error error
  541. }
  542. func readSheetViews(xSheetViews xlsxSheetViews) []SheetView {
  543. if xSheetViews.SheetView == nil || len(xSheetViews.SheetView) == 0 {
  544. return nil
  545. }
  546. sheetViews := []SheetView{}
  547. for _, xSheetView := range xSheetViews.SheetView {
  548. sheetView := SheetView{}
  549. if xSheetView.Pane != nil {
  550. xlsxPane := xSheetView.Pane
  551. pane := &Pane{}
  552. pane.XSplit = xlsxPane.XSplit
  553. pane.YSplit = xlsxPane.YSplit
  554. pane.TopLeftCell = xlsxPane.TopLeftCell
  555. pane.ActivePane = xlsxPane.ActivePane
  556. pane.State = xlsxPane.State
  557. sheetView.Pane = pane
  558. }
  559. sheetViews = append(sheetViews, sheetView)
  560. }
  561. return sheetViews
  562. }
  563. // readSheetFromFile is the logic of converting a xlsxSheet struct
  564. // into a Sheet struct. This work can be done in parallel and so
  565. // readSheetsFromZipFile will spawn an instance of this function per
  566. // sheet and get the results back on the provided channel.
  567. func readSheetFromFile(sc chan *indexedSheet, index int, rsheet xlsxSheet, fi *File, sheetXMLMap map[string]string) {
  568. result := &indexedSheet{Index: index, Sheet: nil, Error: nil}
  569. defer func() {
  570. if e := recover(); e != nil {
  571. switch e.(type) {
  572. case error:
  573. result.Error = e.(error)
  574. default:
  575. result.Error = errors.New("unexpected error")
  576. }
  577. // The only thing here, is if one close the channel. but its not the case
  578. sc <- result
  579. }
  580. }()
  581. worksheet, error := getWorksheetFromSheet(rsheet, fi.worksheets, sheetXMLMap)
  582. if error != nil {
  583. result.Error = error
  584. sc <- result
  585. return
  586. }
  587. sheet := new(Sheet)
  588. sheet.File = fi
  589. sheet.Rows, sheet.Cols, sheet.MaxCol, sheet.MaxRow = readRowsFromSheet(worksheet, fi, sheet)
  590. sheet.Hidden = rsheet.State == sheetStateHidden || rsheet.State == sheetStateVeryHidden
  591. sheet.SheetViews = readSheetViews(worksheet.SheetViews)
  592. sheet.SheetFormat.DefaultColWidth = worksheet.SheetFormatPr.DefaultColWidth
  593. sheet.SheetFormat.DefaultRowHeight = worksheet.SheetFormatPr.DefaultRowHeight
  594. result.Sheet = sheet
  595. sc <- result
  596. }
  597. // readSheetsFromZipFile is an internal helper function that loops
  598. // over the Worksheets defined in the XSLXWorkbook and loads them into
  599. // Sheet objects stored in the Sheets slice of a xlsx.File struct.
  600. func readSheetsFromZipFile(f *zip.File, file *File, sheetXMLMap map[string]string) (map[string]*Sheet, []*Sheet, error) {
  601. var workbook *xlsxWorkbook
  602. var err error
  603. var rc io.ReadCloser
  604. var decoder *xml.Decoder
  605. var sheetCount int
  606. workbook = new(xlsxWorkbook)
  607. rc, err = f.Open()
  608. if err != nil {
  609. return nil, nil, err
  610. }
  611. decoder = xml.NewDecoder(rc)
  612. err = decoder.Decode(workbook)
  613. if err != nil {
  614. return nil, nil, err
  615. }
  616. file.Date1904 = workbook.WorkbookPr.Date1904
  617. for _, entry := range workbook.DefinedNames.DefinedName {
  618. file.DefinedNames = append(file.DefinedNames, &entry)
  619. }
  620. // Only try and read sheets that have corresponding files.
  621. // Notably this excludes chartsheets don't right now
  622. var workbookSheets []xlsxSheet
  623. for _, sheet := range workbook.Sheets.Sheet {
  624. if f := worksheetFileForSheet(sheet, file.worksheets, sheetXMLMap); f != nil {
  625. workbookSheets = append(workbookSheets, sheet)
  626. }
  627. }
  628. sheetCount = len(workbookSheets)
  629. sheetsByName := make(map[string]*Sheet, sheetCount)
  630. sheets := make([]*Sheet, sheetCount)
  631. sheetChan := make(chan *indexedSheet, sheetCount)
  632. defer close(sheetChan)
  633. go func() {
  634. err = nil
  635. for i, rawsheet := range workbookSheets {
  636. readSheetFromFile(sheetChan, i, rawsheet, file, sheetXMLMap)
  637. }
  638. }()
  639. for j := 0; j < sheetCount; j++ {
  640. sheet := <-sheetChan
  641. if sheet.Error != nil {
  642. return nil, nil, sheet.Error
  643. }
  644. sheetName := workbookSheets[sheet.Index].Name
  645. sheetsByName[sheetName] = sheet.Sheet
  646. sheet.Sheet.Name = sheetName
  647. sheets[sheet.Index] = sheet.Sheet
  648. }
  649. return sheetsByName, sheets, nil
  650. }
  651. // readSharedStringsFromZipFile() is an internal helper function to
  652. // extract a reference table from the sharedStrings.xml file within
  653. // the XLSX zip file.
  654. func readSharedStringsFromZipFile(f *zip.File) (*RefTable, error) {
  655. var sst *xlsxSST
  656. var error error
  657. var rc io.ReadCloser
  658. var decoder *xml.Decoder
  659. var reftable *RefTable
  660. // In a file with no strings it's possible that
  661. // sharedStrings.xml doesn't exist. In this case the value
  662. // passed as f will be nil.
  663. if f == nil {
  664. return nil, nil
  665. }
  666. rc, error = f.Open()
  667. if error != nil {
  668. return nil, error
  669. }
  670. sst = new(xlsxSST)
  671. decoder = xml.NewDecoder(rc)
  672. error = decoder.Decode(sst)
  673. if error != nil {
  674. return nil, error
  675. }
  676. reftable = MakeSharedStringRefTable(sst)
  677. return reftable, nil
  678. }
  679. // readStylesFromZipFile() is an internal helper function to
  680. // extract a style table from the style.xml file within
  681. // the XLSX zip file.
  682. func readStylesFromZipFile(f *zip.File, theme *theme) (*xlsxStyleSheet, error) {
  683. var style *xlsxStyleSheet
  684. var error error
  685. var rc io.ReadCloser
  686. var decoder *xml.Decoder
  687. rc, error = f.Open()
  688. if error != nil {
  689. return nil, error
  690. }
  691. style = newXlsxStyleSheet(theme)
  692. decoder = xml.NewDecoder(rc)
  693. error = decoder.Decode(style)
  694. if error != nil {
  695. return nil, error
  696. }
  697. buildNumFmtRefTable(style)
  698. return style, nil
  699. }
  700. func buildNumFmtRefTable(style *xlsxStyleSheet) {
  701. for _, numFmt := range style.NumFmts.NumFmt {
  702. // We do this for the side effect of populating the NumFmtRefTable.
  703. style.addNumFmt(numFmt)
  704. }
  705. }
  706. func readThemeFromZipFile(f *zip.File) (*theme, error) {
  707. rc, err := f.Open()
  708. if err != nil {
  709. return nil, err
  710. }
  711. var themeXml xlsxTheme
  712. err = xml.NewDecoder(rc).Decode(&themeXml)
  713. if err != nil {
  714. return nil, err
  715. }
  716. return newTheme(themeXml), nil
  717. }
  718. type WorkBookRels map[string]string
  719. func (w *WorkBookRels) MakeXLSXWorkbookRels() xlsxWorkbookRels {
  720. relCount := len(*w)
  721. xWorkbookRels := xlsxWorkbookRels{}
  722. xWorkbookRels.Relationships = make([]xlsxWorkbookRelation, relCount+3)
  723. for k, v := range *w {
  724. index, err := strconv.Atoi(k[3:])
  725. if err != nil {
  726. panic(err.Error())
  727. }
  728. xWorkbookRels.Relationships[index-1] = xlsxWorkbookRelation{
  729. Id: k,
  730. Target: v,
  731. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"}
  732. }
  733. relCount++
  734. sheetId := fmt.Sprintf("rId%d", relCount)
  735. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  736. Id: sheetId,
  737. Target: "sharedStrings.xml",
  738. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"}
  739. relCount++
  740. sheetId = fmt.Sprintf("rId%d", relCount)
  741. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  742. Id: sheetId,
  743. Target: "theme/theme1.xml",
  744. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"}
  745. relCount++
  746. sheetId = fmt.Sprintf("rId%d", relCount)
  747. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  748. Id: sheetId,
  749. Target: "styles.xml",
  750. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"}
  751. return xWorkbookRels
  752. }
  753. // readWorkbookRelationsFromZipFile is an internal helper function to
  754. // extract a map of relationship ID strings to the name of the
  755. // worksheet.xml file they refer to. The resulting map can be used to
  756. // reliably derefence the worksheets in the XLSX file.
  757. func readWorkbookRelationsFromZipFile(workbookRels *zip.File) (WorkBookRels, error) {
  758. var sheetXMLMap WorkBookRels
  759. var wbRelationships *xlsxWorkbookRels
  760. var rc io.ReadCloser
  761. var decoder *xml.Decoder
  762. var err error
  763. rc, err = workbookRels.Open()
  764. if err != nil {
  765. return nil, err
  766. }
  767. decoder = xml.NewDecoder(rc)
  768. wbRelationships = new(xlsxWorkbookRels)
  769. err = decoder.Decode(wbRelationships)
  770. if err != nil {
  771. return nil, err
  772. }
  773. sheetXMLMap = make(WorkBookRels)
  774. for _, rel := range wbRelationships.Relationships {
  775. if strings.HasSuffix(rel.Target, ".xml") && rel.Type == "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" {
  776. _, filename := path.Split(rel.Target)
  777. sheetXMLMap[rel.Id] = strings.Replace(filename, ".xml", "", 1)
  778. }
  779. }
  780. return sheetXMLMap, nil
  781. }
  782. // ReadZip() takes a pointer to a zip.ReadCloser and returns a
  783. // xlsx.File struct populated with its contents. In most cases
  784. // ReadZip is not used directly, but is called internally by OpenFile.
  785. func ReadZip(f *zip.ReadCloser) (*File, error) {
  786. defer f.Close()
  787. return ReadZipReader(&f.Reader)
  788. }
  789. // ReadZipReader() can be used to read an XLSX in memory without
  790. // touching the filesystem.
  791. func ReadZipReader(r *zip.Reader) (*File, error) {
  792. var err error
  793. var file *File
  794. var reftable *RefTable
  795. var sharedStrings *zip.File
  796. var sheetXMLMap map[string]string
  797. var sheetsByName map[string]*Sheet
  798. var sheets []*Sheet
  799. var style *xlsxStyleSheet
  800. var styles *zip.File
  801. var themeFile *zip.File
  802. var v *zip.File
  803. var workbook *zip.File
  804. var workbookRels *zip.File
  805. var worksheets map[string]*zip.File
  806. file = NewFile()
  807. // file.numFmtRefTable = make(map[int]xlsxNumFmt, 1)
  808. worksheets = make(map[string]*zip.File, len(r.File))
  809. for _, v = range r.File {
  810. switch v.Name {
  811. case "xl/sharedStrings.xml":
  812. sharedStrings = v
  813. case "xl/workbook.xml":
  814. workbook = v
  815. case "xl/_rels/workbook.xml.rels":
  816. workbookRels = v
  817. case "xl/styles.xml":
  818. styles = v
  819. case "xl/theme/theme1.xml":
  820. themeFile = v
  821. default:
  822. if len(v.Name) > 14 {
  823. if v.Name[0:13] == "xl/worksheets" {
  824. worksheets[v.Name[14:len(v.Name)-4]] = v
  825. }
  826. }
  827. }
  828. }
  829. if workbookRels == nil {
  830. return nil, fmt.Errorf("xl/_rels/workbook.xml.rels not found in input xlsx.")
  831. }
  832. sheetXMLMap, err = readWorkbookRelationsFromZipFile(workbookRels)
  833. if err != nil {
  834. return nil, err
  835. }
  836. if len(worksheets) == 0 {
  837. return nil, fmt.Errorf("Input xlsx contains no worksheets.")
  838. }
  839. file.worksheets = worksheets
  840. reftable, err = readSharedStringsFromZipFile(sharedStrings)
  841. if err != nil {
  842. return nil, err
  843. }
  844. file.referenceTable = reftable
  845. if themeFile != nil {
  846. theme, err := readThemeFromZipFile(themeFile)
  847. if err != nil {
  848. return nil, err
  849. }
  850. file.theme = theme
  851. }
  852. if styles != nil {
  853. style, err = readStylesFromZipFile(styles, file.theme)
  854. if err != nil {
  855. return nil, err
  856. }
  857. file.styles = style
  858. }
  859. sheetsByName, sheets, err = readSheetsFromZipFile(workbook, file, sheetXMLMap)
  860. if err != nil {
  861. return nil, err
  862. }
  863. if sheets == nil {
  864. readerErr := new(XLSXReaderError)
  865. readerErr.Err = "No sheets found in XLSX File"
  866. return nil, readerErr
  867. }
  868. file.Sheet = sheetsByName
  869. file.Sheets = sheets
  870. return file, nil
  871. }