lib.go 29 KB

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