lib.go 26 KB

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