lib.go 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064
  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. var data = rawcell.V
  400. if len(data) > 0 {
  401. vval := strings.Trim(data, " \t\n\r")
  402. switch rawcell.T {
  403. case "s": // Shared String
  404. ref, error := strconv.Atoi(vval)
  405. if error != nil {
  406. panic(error)
  407. }
  408. cell.Value = reftable.ResolveSharedString(ref)
  409. cell.cellType = CellTypeString
  410. case "b": // Boolean
  411. cell.Value = vval
  412. cell.cellType = CellTypeBool
  413. case "e": // Error
  414. cell.Value = vval
  415. cell.formula = formulaForCell(rawcell, sharedFormulas)
  416. cell.cellType = CellTypeError
  417. default:
  418. if rawcell.F == nil {
  419. // Numeric
  420. cell.Value = vval
  421. cell.cellType = CellTypeNumeric
  422. } else {
  423. // Formula
  424. cell.Value = vval
  425. cell.formula = formulaForCell(rawcell, sharedFormulas)
  426. cell.cellType = CellTypeFormula
  427. }
  428. }
  429. } else {
  430. if rawcell.Is != nil {
  431. fillCellDataFromInlineString(rawcell, cell)
  432. }
  433. }
  434. }
  435. // fillCellDataFromInlineString attempts to get inline string data and put it into a Cell.
  436. func fillCellDataFromInlineString(rawcell xlsxC, cell *Cell) {
  437. if rawcell.Is.T != "" {
  438. cell.Value = strings.Trim(rawcell.Is.T, " \t\n\r")
  439. cell.cellType = CellTypeInline
  440. } else {
  441. cell.Value = ""
  442. for _, r := range rawcell.Is.R {
  443. cell.Value += r.T
  444. }
  445. }
  446. }
  447. // readRowsFromSheet is an internal helper function that extracts the
  448. // rows from a XSLXWorksheet, populates them with Cells and resolves
  449. // the value references from the reference table and stores them in
  450. // the rows and columns.
  451. func readRowsFromSheet(Worksheet *xlsxWorksheet, file *File, sheet *Sheet, rowLimit int) ([]*Row, []*Col, int, int) {
  452. var rows []*Row
  453. var cols []*Col
  454. var row *Row
  455. var minCol, maxCol, minRow, maxRow, colCount, rowCount int
  456. var reftable *RefTable
  457. var err error
  458. var insertRowIndex, insertColIndex int
  459. sharedFormulas := map[int]sharedFormula{}
  460. if len(Worksheet.SheetData.Row) == 0 {
  461. return nil, nil, 0, 0
  462. }
  463. reftable = file.referenceTable
  464. if len(Worksheet.Dimension.Ref) > 0 && len(strings.Split(Worksheet.Dimension.Ref, ":")) == 2 && rowLimit == NoRowLimit {
  465. minCol, minRow, maxCol, maxRow, err = getMaxMinFromDimensionRef(Worksheet.Dimension.Ref)
  466. } else {
  467. minCol, minRow, maxCol, maxRow, err = calculateMaxMinFromWorksheet(Worksheet)
  468. }
  469. if err != nil {
  470. panic(err.Error())
  471. }
  472. rowCount = maxRow + 1
  473. colCount = maxCol + 1
  474. rows = make([]*Row, rowCount)
  475. cols = make([]*Col, colCount)
  476. insertRowIndex = minRow
  477. for i := range cols {
  478. cols[i] = &Col{
  479. Hidden: false,
  480. }
  481. }
  482. if Worksheet.Cols != nil {
  483. // Columns can apply to a range, for convenience we expand the
  484. // ranges out into individual column definitions.
  485. for _, rawcol := range Worksheet.Cols.Col {
  486. // Note, below, that sometimes column definitions can
  487. // exist outside the defined dimensions of the
  488. // spreadsheet - we deliberately exclude these
  489. // columns.
  490. for i := rawcol.Min; i <= rawcol.Max && i <= colCount; i++ {
  491. col := &Col{
  492. Min: rawcol.Min,
  493. Max: rawcol.Max,
  494. Hidden: rawcol.Hidden,
  495. Width: rawcol.Width,
  496. OutlineLevel: rawcol.OutlineLevel}
  497. cols[i-1] = col
  498. if file.styles != nil {
  499. col.style = file.styles.getStyle(rawcol.Style)
  500. col.numFmt, col.parsedNumFmt = file.styles.getNumberFormat(rawcol.Style)
  501. }
  502. }
  503. }
  504. }
  505. // insert leading empty rows that is in front of minRow
  506. for rowIndex := 0; rowIndex < minRow; rowIndex++ {
  507. rows[rowIndex] = makeEmptyRow(sheet)
  508. }
  509. numRows := len(rows)
  510. for rowIndex := 0; rowIndex < len(Worksheet.SheetData.Row); rowIndex++ {
  511. rawrow := Worksheet.SheetData.Row[rowIndex]
  512. // Some spreadsheets will omit blank rows from the
  513. // stored data
  514. for rawrow.R > (insertRowIndex + 1) {
  515. // Put an empty Row into the array
  516. if insertRowIndex < numRows {
  517. rows[insertRowIndex] = makeEmptyRow(sheet)
  518. }
  519. insertRowIndex++
  520. }
  521. // range is not empty and only one range exist
  522. if len(rawrow.Spans) != 0 && strings.Count(rawrow.Spans, ":") == 1 {
  523. row = makeRowFromSpan(rawrow.Spans, sheet)
  524. } else {
  525. row = makeRowFromRaw(rawrow, sheet)
  526. }
  527. row.Hidden = rawrow.Hidden
  528. height, err := strconv.ParseFloat(rawrow.Ht, 64)
  529. if err == nil {
  530. row.Height = height
  531. }
  532. row.isCustom = rawrow.CustomHeight
  533. row.OutlineLevel = rawrow.OutlineLevel
  534. insertColIndex = minCol
  535. for _, rawcell := range rawrow.C {
  536. h, v, err := Worksheet.MergeCells.getExtent(rawcell.R)
  537. if err != nil {
  538. panic(err.Error())
  539. }
  540. x, _, _ := GetCoordsFromCellIDString(rawcell.R)
  541. // K1000000: Prevent panic when the range specified in the spreadsheet
  542. // view exceeds the actual number of columns in the dataset.
  543. // Some spreadsheets will omit blank cells
  544. // from the data.
  545. for x > insertColIndex {
  546. // Put an empty Cell into the array
  547. if insertColIndex < len(row.Cells) {
  548. row.Cells[insertColIndex] = new(Cell)
  549. }
  550. insertColIndex++
  551. }
  552. cellX := insertColIndex
  553. if cellX < len(row.Cells) {
  554. cell := row.Cells[cellX]
  555. cell.HMerge = h
  556. cell.VMerge = v
  557. fillCellData(rawcell, reftable, sharedFormulas, cell)
  558. if file.styles != nil {
  559. cell.style = file.styles.getStyle(rawcell.S)
  560. cell.NumFmt, cell.parsedNumFmt = file.styles.getNumberFormat(rawcell.S)
  561. }
  562. cell.date1904 = file.Date1904
  563. // Cell is considered hidden if the row or the column of this cell is hidden
  564. cell.Hidden = rawrow.Hidden || (len(cols) > cellX && cols[cellX].Hidden)
  565. insertColIndex++
  566. }
  567. }
  568. if len(rows) > insertRowIndex {
  569. rows[insertRowIndex] = row
  570. }
  571. insertRowIndex++
  572. }
  573. return rows, cols, colCount, rowCount
  574. }
  575. type indexedSheet struct {
  576. Index int
  577. Sheet *Sheet
  578. Error error
  579. }
  580. func readSheetViews(xSheetViews xlsxSheetViews) []SheetView {
  581. if xSheetViews.SheetView == nil || len(xSheetViews.SheetView) == 0 {
  582. return nil
  583. }
  584. sheetViews := []SheetView{}
  585. for _, xSheetView := range xSheetViews.SheetView {
  586. sheetView := SheetView{}
  587. if xSheetView.Pane != nil {
  588. xlsxPane := xSheetView.Pane
  589. pane := &Pane{}
  590. pane.XSplit = xlsxPane.XSplit
  591. pane.YSplit = xlsxPane.YSplit
  592. pane.TopLeftCell = xlsxPane.TopLeftCell
  593. pane.ActivePane = xlsxPane.ActivePane
  594. pane.State = xlsxPane.State
  595. sheetView.Pane = pane
  596. }
  597. sheetViews = append(sheetViews, sheetView)
  598. }
  599. return sheetViews
  600. }
  601. // readSheetFromFile is the logic of converting a xlsxSheet struct
  602. // into a Sheet struct. This work can be done in parallel and so
  603. // readSheetsFromZipFile will spawn an instance of this function per
  604. // sheet and get the results back on the provided channel.
  605. func readSheetFromFile(sc chan *indexedSheet, index int, rsheet xlsxSheet, fi *File, sheetXMLMap map[string]string, rowLimit int) (errRes error) {
  606. result := &indexedSheet{Index: index, Sheet: nil, Error: nil}
  607. defer func() {
  608. if e := recover(); e != nil {
  609. switch e.(type) {
  610. case error:
  611. result.Error = e.(error)
  612. errRes = e.(error)
  613. default:
  614. result.Error = errors.New("unexpected error")
  615. }
  616. // The only thing here, is if one close the channel. but its not the case
  617. sc <- result
  618. }
  619. }()
  620. worksheet, err := getWorksheetFromSheet(rsheet, fi.worksheets, sheetXMLMap, rowLimit)
  621. if err != nil {
  622. result.Error = err
  623. sc <- result
  624. return err
  625. }
  626. sheet := new(Sheet)
  627. sheet.File = fi
  628. sheet.Rows, sheet.Cols, sheet.MaxCol, sheet.MaxRow = readRowsFromSheet(worksheet, fi, sheet, rowLimit)
  629. sheet.Hidden = rsheet.State == sheetStateHidden || rsheet.State == sheetStateVeryHidden
  630. sheet.SheetViews = readSheetViews(worksheet.SheetViews)
  631. sheet.SheetFormat.DefaultColWidth = worksheet.SheetFormatPr.DefaultColWidth
  632. sheet.SheetFormat.DefaultRowHeight = worksheet.SheetFormatPr.DefaultRowHeight
  633. sheet.SheetFormat.OutlineLevelCol = worksheet.SheetFormatPr.OutlineLevelCol
  634. sheet.SheetFormat.OutlineLevelRow = worksheet.SheetFormatPr.OutlineLevelRow
  635. result.Sheet = sheet
  636. sc <- result
  637. return nil
  638. }
  639. // readSheetsFromZipFile is an internal helper function that loops
  640. // over the Worksheets defined in the XSLXWorkbook and loads them into
  641. // Sheet objects stored in the Sheets slice of a xlsx.File struct.
  642. func readSheetsFromZipFile(f *zip.File, file *File, sheetXMLMap map[string]string, rowLimit int) (map[string]*Sheet, []*Sheet, error) {
  643. var workbook *xlsxWorkbook
  644. var err error
  645. var rc io.ReadCloser
  646. var decoder *xml.Decoder
  647. var sheetCount int
  648. workbook = new(xlsxWorkbook)
  649. rc, err = f.Open()
  650. if err != nil {
  651. return nil, nil, err
  652. }
  653. decoder = xml.NewDecoder(rc)
  654. err = decoder.Decode(workbook)
  655. if err != nil {
  656. return nil, nil, err
  657. }
  658. file.Date1904 = workbook.WorkbookPr.Date1904
  659. for entryNum := range workbook.DefinedNames.DefinedName {
  660. file.DefinedNames = append(file.DefinedNames, &workbook.DefinedNames.DefinedName[entryNum])
  661. }
  662. // Only try and read sheets that have corresponding files.
  663. // Notably this excludes chartsheets don't right now
  664. var workbookSheets []xlsxSheet
  665. for _, sheet := range workbook.Sheets.Sheet {
  666. if f := worksheetFileForSheet(sheet, file.worksheets, sheetXMLMap); f != nil {
  667. workbookSheets = append(workbookSheets, sheet)
  668. }
  669. }
  670. sheetCount = len(workbookSheets)
  671. sheetsByName := make(map[string]*Sheet, sheetCount)
  672. sheets := make([]*Sheet, sheetCount)
  673. sheetChan := make(chan *indexedSheet, sheetCount)
  674. go func() {
  675. defer close(sheetChan)
  676. err = nil
  677. for i, rawsheet := range workbookSheets {
  678. if err := readSheetFromFile(sheetChan, i, rawsheet, file, sheetXMLMap, rowLimit); err != nil {
  679. return
  680. }
  681. }
  682. }()
  683. for j := 0; j < sheetCount; j++ {
  684. sheet := <-sheetChan
  685. if sheet.Error != nil {
  686. return nil, nil, sheet.Error
  687. }
  688. sheetName := workbookSheets[sheet.Index].Name
  689. sheetsByName[sheetName] = sheet.Sheet
  690. sheet.Sheet.Name = sheetName
  691. sheets[sheet.Index] = sheet.Sheet
  692. }
  693. return sheetsByName, sheets, nil
  694. }
  695. // readSharedStringsFromZipFile() is an internal helper function to
  696. // extract a reference table from the sharedStrings.xml file within
  697. // the XLSX zip file.
  698. func readSharedStringsFromZipFile(f *zip.File) (*RefTable, error) {
  699. var sst *xlsxSST
  700. var error error
  701. var rc io.ReadCloser
  702. var decoder *xml.Decoder
  703. var reftable *RefTable
  704. // In a file with no strings it's possible that
  705. // sharedStrings.xml doesn't exist. In this case the value
  706. // passed as f will be nil.
  707. if f == nil {
  708. return nil, nil
  709. }
  710. rc, error = f.Open()
  711. if error != nil {
  712. return nil, error
  713. }
  714. sst = new(xlsxSST)
  715. decoder = xml.NewDecoder(rc)
  716. error = decoder.Decode(sst)
  717. if error != nil {
  718. return nil, error
  719. }
  720. reftable = MakeSharedStringRefTable(sst)
  721. return reftable, nil
  722. }
  723. // readStylesFromZipFile() is an internal helper function to
  724. // extract a style table from the style.xml file within
  725. // the XLSX zip file.
  726. func readStylesFromZipFile(f *zip.File, theme *theme) (*xlsxStyleSheet, error) {
  727. var style *xlsxStyleSheet
  728. var error error
  729. var rc io.ReadCloser
  730. var decoder *xml.Decoder
  731. rc, error = f.Open()
  732. if error != nil {
  733. return nil, error
  734. }
  735. style = newXlsxStyleSheet(theme)
  736. decoder = xml.NewDecoder(rc)
  737. error = decoder.Decode(style)
  738. if error != nil {
  739. return nil, error
  740. }
  741. buildNumFmtRefTable(style)
  742. return style, nil
  743. }
  744. func buildNumFmtRefTable(style *xlsxStyleSheet) {
  745. for _, numFmt := range style.NumFmts.NumFmt {
  746. // We do this for the side effect of populating the NumFmtRefTable.
  747. style.addNumFmt(numFmt)
  748. }
  749. }
  750. func readThemeFromZipFile(f *zip.File) (*theme, error) {
  751. rc, err := f.Open()
  752. if err != nil {
  753. return nil, err
  754. }
  755. var themeXml xlsxTheme
  756. err = xml.NewDecoder(rc).Decode(&themeXml)
  757. if err != nil {
  758. return nil, err
  759. }
  760. return newTheme(themeXml), nil
  761. }
  762. type WorkBookRels map[string]string
  763. func (w *WorkBookRels) MakeXLSXWorkbookRels() xlsxWorkbookRels {
  764. relCount := len(*w)
  765. xWorkbookRels := xlsxWorkbookRels{}
  766. xWorkbookRels.Relationships = make([]xlsxWorkbookRelation, relCount+3)
  767. for k, v := range *w {
  768. index, err := strconv.Atoi(k[3:])
  769. if err != nil {
  770. panic(err.Error())
  771. }
  772. xWorkbookRels.Relationships[index-1] = xlsxWorkbookRelation{
  773. Id: k,
  774. Target: v,
  775. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"}
  776. }
  777. relCount++
  778. sheetId := fmt.Sprintf("rId%d", relCount)
  779. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  780. Id: sheetId,
  781. Target: "sharedStrings.xml",
  782. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"}
  783. relCount++
  784. sheetId = fmt.Sprintf("rId%d", relCount)
  785. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  786. Id: sheetId,
  787. Target: "theme/theme1.xml",
  788. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"}
  789. relCount++
  790. sheetId = fmt.Sprintf("rId%d", relCount)
  791. xWorkbookRels.Relationships[relCount-1] = xlsxWorkbookRelation{
  792. Id: sheetId,
  793. Target: "styles.xml",
  794. Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"}
  795. return xWorkbookRels
  796. }
  797. // readWorkbookRelationsFromZipFile is an internal helper function to
  798. // extract a map of relationship ID strings to the name of the
  799. // worksheet.xml file they refer to. The resulting map can be used to
  800. // reliably derefence the worksheets in the XLSX file.
  801. func readWorkbookRelationsFromZipFile(workbookRels *zip.File) (WorkBookRels, error) {
  802. var sheetXMLMap WorkBookRels
  803. var wbRelationships *xlsxWorkbookRels
  804. var rc io.ReadCloser
  805. var decoder *xml.Decoder
  806. var err error
  807. rc, err = workbookRels.Open()
  808. if err != nil {
  809. return nil, err
  810. }
  811. decoder = xml.NewDecoder(rc)
  812. wbRelationships = new(xlsxWorkbookRels)
  813. err = decoder.Decode(wbRelationships)
  814. if err != nil {
  815. return nil, err
  816. }
  817. sheetXMLMap = make(WorkBookRels)
  818. for _, rel := range wbRelationships.Relationships {
  819. if strings.HasSuffix(rel.Target, ".xml") && rel.Type == "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" {
  820. _, filename := path.Split(rel.Target)
  821. sheetXMLMap[rel.Id] = strings.Replace(filename, ".xml", "", 1)
  822. }
  823. }
  824. return sheetXMLMap, nil
  825. }
  826. // ReadZip() takes a pointer to a zip.ReadCloser and returns a
  827. // xlsx.File struct populated with its contents. In most cases
  828. // ReadZip is not used directly, but is called internally by OpenFile.
  829. func ReadZip(f *zip.ReadCloser) (*File, error) {
  830. return ReadZipWithRowLimit(f, NoRowLimit)
  831. }
  832. // ReadZipWithRowLimit() takes a pointer to a zip.ReadCloser and returns a
  833. // xlsx.File struct populated with its contents. In most cases
  834. // ReadZip is not used directly, but is called internally by OpenFile.
  835. func ReadZipWithRowLimit(f *zip.ReadCloser, rowLimit int) (*File, error) {
  836. defer f.Close()
  837. return ReadZipReaderWithRowLimit(&f.Reader, rowLimit)
  838. }
  839. // ReadZipReader() can be used to read an XLSX in memory without
  840. // touching the filesystem.
  841. func ReadZipReader(r *zip.Reader) (*File, error) {
  842. return ReadZipReaderWithRowLimit(r, NoRowLimit)
  843. }
  844. // ReadZipReaderWithRowLimit() can be used to read an XLSX in memory without
  845. // touching the filesystem.
  846. // rowLimit is the number of rows that should be read from the file. If rowLimit is -1, no limit is applied.
  847. // You can specify this with the constant NoRowLimit.
  848. func ReadZipReaderWithRowLimit(r *zip.Reader, rowLimit int) (*File, error) {
  849. var err error
  850. var file *File
  851. var reftable *RefTable
  852. var sharedStrings *zip.File
  853. var sheetXMLMap map[string]string
  854. var sheetsByName map[string]*Sheet
  855. var sheets []*Sheet
  856. var style *xlsxStyleSheet
  857. var styles *zip.File
  858. var themeFile *zip.File
  859. var v *zip.File
  860. var workbook *zip.File
  861. var workbookRels *zip.File
  862. var worksheets map[string]*zip.File
  863. file = NewFile()
  864. // file.numFmtRefTable = make(map[int]xlsxNumFmt, 1)
  865. worksheets = make(map[string]*zip.File, len(r.File))
  866. for _, v = range r.File {
  867. switch v.Name {
  868. case "xl/sharedStrings.xml":
  869. sharedStrings = v
  870. case "xl/workbook.xml":
  871. workbook = v
  872. case "xl/_rels/workbook.xml.rels":
  873. workbookRels = v
  874. case "xl/styles.xml":
  875. styles = v
  876. case "xl/theme/theme1.xml":
  877. themeFile = v
  878. default:
  879. if len(v.Name) > 14 {
  880. if v.Name[0:13] == "xl/worksheets" {
  881. worksheets[v.Name[14:len(v.Name)-4]] = v
  882. }
  883. }
  884. }
  885. }
  886. if workbookRels == nil {
  887. return nil, fmt.Errorf("xl/_rels/workbook.xml.rels not found in input xlsx.")
  888. }
  889. sheetXMLMap, err = readWorkbookRelationsFromZipFile(workbookRels)
  890. if err != nil {
  891. return nil, err
  892. }
  893. if len(worksheets) == 0 {
  894. return nil, fmt.Errorf("Input xlsx contains no worksheets.")
  895. }
  896. file.worksheets = worksheets
  897. reftable, err = readSharedStringsFromZipFile(sharedStrings)
  898. if err != nil {
  899. return nil, err
  900. }
  901. file.referenceTable = reftable
  902. if themeFile != nil {
  903. theme, err := readThemeFromZipFile(themeFile)
  904. if err != nil {
  905. return nil, err
  906. }
  907. file.theme = theme
  908. }
  909. if styles != nil {
  910. style, err = readStylesFromZipFile(styles, file.theme)
  911. if err != nil {
  912. return nil, err
  913. }
  914. file.styles = style
  915. }
  916. sheetsByName, sheets, err = readSheetsFromZipFile(workbook, file, sheetXMLMap, rowLimit)
  917. if err != nil {
  918. return nil, err
  919. }
  920. if sheets == nil {
  921. readerErr := new(XLSXReaderError)
  922. readerErr.Err = "No sheets found in XLSX File"
  923. return nil, readerErr
  924. }
  925. file.Sheet = sheetsByName
  926. file.Sheets = sheets
  927. return file, nil
  928. }
  929. // truncateSheetXML will take in a reader to an XML sheet file and will return a reader that will read an equivalent
  930. // XML sheet file with only the number of rows specified. This greatly speeds up XML unmarshalling when only
  931. // a few rows need to be read from a large sheet.
  932. // When sheets are truncated, all formatting present after the sheetData tag will be lost, but all of this formatting
  933. // is related to printing and visibility, and is out of scope for most purposes of this library.
  934. func truncateSheetXML(r io.Reader, rowLimit int) (io.Reader, error) {
  935. var rowCount int
  936. var token xml.Token
  937. var readErr error
  938. output := new(bytes.Buffer)
  939. r = io.TeeReader(r, output)
  940. decoder := xml.NewDecoder(r)
  941. for {
  942. token, readErr = decoder.Token()
  943. if readErr == io.EOF {
  944. break
  945. } else if readErr != nil {
  946. return nil, readErr
  947. }
  948. end, ok := token.(xml.EndElement)
  949. if ok && end.Name.Local == "row" {
  950. rowCount++
  951. if rowCount >= rowLimit {
  952. break
  953. }
  954. }
  955. }
  956. offset := decoder.InputOffset()
  957. output.Truncate(int(offset))
  958. if readErr != io.EOF {
  959. _, err := output.Write([]byte(sheetEnding))
  960. if err != nil {
  961. return nil, err
  962. }
  963. }
  964. return output, nil
  965. }