-
-
Notifications
You must be signed in to change notification settings - Fork 415
Expand file tree
/
Copy pathOpenXmlReader.cs
More file actions
1497 lines (1298 loc) · 61.7 KB
/
OpenXmlReader.cs
File metadata and controls
1497 lines (1298 loc) · 61.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System.Collections.ObjectModel;
using System.Xml.Linq;
using MiniExcelLib.Core;
using MiniExcelLib.OpenXml.Constants;
using MiniExcelLib.OpenXml.Styles;
using MiniExcelMapper = MiniExcelLib.Core.Reflection.MiniExcelMapper;
using XmlReaderHelper = MiniExcelLib.OpenXml.Utils.XmlReaderHelper;
namespace MiniExcelLib.OpenXml;
internal partial class OpenXmlReader : IMiniExcelReader
{
private static readonly string[] Ns = [Schemas.SpreadsheetmlXmlMain, Schemas.SpreadsheetmlXmlStrictNs];
private static readonly string[] RelationshiopNs = [Schemas.SpreadsheetmlXmlRelationships, Schemas.SpreadsheetmlXmlStrictRelationships];
private readonly OpenXmlConfiguration _config;
private List<SheetRecord>? _sheetRecords;
private OpenXmlStyles? _style;
private bool _disposed;
internal readonly OpenXmlZip Archive;
internal IDictionary<int, string> SharedStrings = new Dictionary<int, string>();
private OpenXmlReader(OpenXmlZip openXmlZip, IMiniExcelConfiguration? configuration)
{
Archive = openXmlZip;
_config = (OpenXmlConfiguration?)configuration ?? OpenXmlConfiguration.Default;
}
[CreateSyncVersion]
internal static async Task<OpenXmlReader> CreateAsync(Stream stream, IMiniExcelConfiguration? configuration, CancellationToken cancellationToken = default)
{
ThrowHelper.ThrowIfInvalidOpenXml(stream);
var archive = await OpenXmlZip.CreateAsync(stream, cancellationToken: cancellationToken).ConfigureAwait(false);
var reader = new OpenXmlReader(archive, configuration);
await reader.SetSharedStringsAsync(cancellationToken).ConfigureAwait(false);
return reader;
}
[CreateSyncVersion]
public IAsyncEnumerable<IDictionary<string, object?>> QueryAsync(bool useHeaderRow, string? sheetName, string startCell, CancellationToken cancellationToken = default)
{
return QueryRangeAsync(useHeaderRow, sheetName, startCell, "", cancellationToken);
}
[CreateSyncVersion]
public IAsyncEnumerable<T> QueryAsync<T>(string? sheetName, string startCell, bool mapHeaderAsData, CancellationToken cancellationToken = default) where T : class, new()
{
sheetName ??= MiniExcelPropertyHelper.GetExcellSheetInfo(typeof(T), _config)?.ExcelSheetName;
var query = QueryAsync(false, sheetName, startCell, cancellationToken);
if (!CellReferenceConverter.TryParseCellReference(startCell, out _, out var rowOffset))
{
throw new InvalidDataException($"Value {startCell} is not a valid cell reference.");
}
//Todo: Find a way if possible to remove the 'hasHeader' parameter to check whether or not to include
// the first row in the result set in favor of modifying the already present 'useHeaderRow' to do the same job
return MiniExcelMapper.MapQueryAsync<T>(query, rowOffset, mapHeaderAsData, _config.TrimColumnNames, _config, XmlHelper.DecodeString, cancellationToken);
}
[CreateSyncVersion]
public IAsyncEnumerable<IDictionary<string, object?>> QueryRangeAsync(bool useHeaderRow, string? sheetName, string startCell, string endCell, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
if (!CellReferenceConverter.TryParseCellReference(startCell, out var startColumnIndex, out var startRowIndex))
throw new InvalidDataException($"Value {startCell} is not a valid cell reference.");
// convert to 0-based
startColumnIndex--;
startRowIndex--;
// endCell is allowed to be empty to query for all rows and columns
int? endColumnIndex = null;
int? endRowIndex = null;
if (!string.IsNullOrWhiteSpace(endCell))
{
if (!CellReferenceConverter.TryParseCellReference(endCell, out int cIndex, out int rIndex))
throw new InvalidDataException($"Value {endCell} is not a valid cell reference.");
// convert to 0-based
endColumnIndex = cIndex - 1;
endRowIndex = rIndex - 1;
}
return InternalQueryRangeAsync(useHeaderRow, sheetName, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, cancellationToken);
}
[CreateSyncVersion]
public IAsyncEnumerable<T> QueryRangeAsync<T>(string? sheetName, string startCell, string endCell, bool treatHeaderAsData, CancellationToken cancellationToken = default) where T : class, new()
{
var query = QueryRangeAsync(false, sheetName, startCell, endCell, cancellationToken);
if (!CellReferenceConverter.TryParseCellReference(startCell, out _, out var rowOffset))
throw new InvalidDataException($"Value {startCell} is not a valid cell reference.");
return MiniExcelMapper.MapQueryAsync<T>(query, rowOffset, treatHeaderAsData, _config.TrimColumnNames, _config, XmlHelper.DecodeString, cancellationToken);
}
[CreateSyncVersion]
public IAsyncEnumerable<IDictionary<string, object?>> QueryRangeAsync(bool useHeaderRow, string? sheetName, int startRowIndex, int startColumnIndex, int? endRowIndex, int? endColumnIndex, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
if (startRowIndex <= 0)
throw new ArgumentOutOfRangeException(nameof(startRowIndex), "Start row index is 1-based and must be greater than 0.");
if (startColumnIndex <= 0)
throw new ArgumentOutOfRangeException(nameof(startColumnIndex), "Start column index is 1-based and must be greater than 0.");
// convert to 0-based
startColumnIndex--;
startRowIndex--;
if (endRowIndex.HasValue)
{
if (endRowIndex.Value <= 0)
throw new ArgumentOutOfRangeException(nameof(endRowIndex), "End row index is 1-based and must be greater than 0.");
// convert to 0-based
endRowIndex--;
}
if (endColumnIndex.HasValue)
{
if (endColumnIndex.Value > 0)
{
// convert to 0-based
endColumnIndex--;
}
else
{
throw new ArgumentOutOfRangeException(nameof(endColumnIndex), "End column index is 1-based and must be greater than 0.");
}
}
return InternalQueryRangeAsync(useHeaderRow, sheetName, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, cancellationToken);
}
[CreateSyncVersion]
public IAsyncEnumerable<T> QueryRangeAsync<T>(string? sheetName, int startRowIndex, int startColumnIndex, int? endRowIndex, int? endColumnIndex, bool treatHeaderAsData, CancellationToken cancellationToken = default) where T : class, new()
{
var query = QueryRangeAsync(false, sheetName, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, cancellationToken);
return MiniExcelMapper.MapQueryAsync<T>(query, startRowIndex, treatHeaderAsData, _config.TrimColumnNames, _config, XmlHelper.DecodeString, cancellationToken);
}
[CreateSyncVersion]
private async IAsyncEnumerable<IDictionary<string, object?>> InternalQueryRangeAsync(bool useHeaderRow, string? sheetName, int startRowIndex, int startColumnIndex, int? endRowIndex, int? endColumnIndex, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
var xmlSettings = XmlReaderHelper.GetXmlReaderSettings(
#if SYNC_ONLY
false
#else
true
#endif
);
var sheetEntry = GetSheetEntry(sheetName);
// TODO: need to optimize performance
// Q. why need 3 times openstream merge one open read? A. no, zipstream can't use position = 0
var mergeCellsContext = new MergeCellsContext();
if (_config.FillMergedCells && !await TryGetMergeCellsAsync(sheetEntry, mergeCellsContext, cancellationToken).ConfigureAwait(false))
yield break;
var maxRowColumnIndexResult = await TryGetMaxRowColumnIndexAsync(sheetEntry, cancellationToken).ConfigureAwait(false);
if (!maxRowColumnIndexResult.IsSuccess)
yield break;
var maxRowIndex = maxRowColumnIndexResult.MaxRowIndex;
var maxColumnIndex = maxRowColumnIndexResult.MaxColumnIndex;
var withoutCr = maxRowColumnIndexResult.WithoutCr;
if (endColumnIndex.HasValue)
{
maxColumnIndex = endColumnIndex.Value;
}
#if NET10_0_OR_GREATER
var sheetStream = await sheetEntry.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableSheetStream = sheetStream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var sheetStream = sheetEntry.Open();
await using var disposableSheetStream = sheetStream.ConfigureAwait(false);
#else
using var sheetStream = sheetEntry.Open();
#endif
using var reader = XmlReader.Create(sheetStream, xmlSettings);
if (!XmlReaderHelper.IsStartElement(reader, "worksheet", Ns))
yield break;
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
yield break;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "sheetData", Ns))
{
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
continue;
int rowIndex = -1;
bool isFirstRow = true;
var headRows = new Dictionary<int, string>();
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "row", Ns))
{
var nextRowIndex = rowIndex + 1;
if (int.TryParse(reader.GetAttribute("r"), out int arValue))
rowIndex = arValue - 1; // The row attribute is 1-based
else
rowIndex++;
if (rowIndex < startRowIndex)
{
if (await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
await XmlReaderHelper.SkipToNextSameLevelDomAsync(reader, cancellationToken).ConfigureAwait(false);
}
continue;
}
if (rowIndex > endRowIndex)
{
break;
}
await foreach (var row in QueryRowAsync(reader, isFirstRow, startRowIndex, nextRowIndex,
rowIndex, startColumnIndex, endColumnIndex, maxColumnIndex,
withoutCr, useHeaderRow, headRows, mergeCellsContext.MergeCells,
cancellationToken).ConfigureAwait(false))
{
if (isFirstRow)
{
isFirstRow = false; // for startcell logic
if (useHeaderRow)
continue;
}
yield return row;
}
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
[CreateSyncVersion]
private async IAsyncEnumerable<IDictionary<string, object?>> QueryRowAsync(
XmlReader reader,
bool isFirstRow,
int startRowIndex,
int nextRowIndex,
int rowIndex,
int startColumnIndex,
int? endColumnIndex,
int maxColumnIndex,
bool withoutCr,
bool useHeaderRow,
Dictionary<int, string> headRows,
MergeCells? mergeCells,
[EnumeratorCancellation] CancellationToken cancellationToken = default)
{
// fill empty rows
if (!_config.IgnoreEmptyRows)
{
var expectedRowIndex = isFirstRow ? startRowIndex : nextRowIndex;
if (startRowIndex <= expectedRowIndex && expectedRowIndex < rowIndex)
{
for (int i = expectedRowIndex; i < rowIndex; i++)
{
yield return GetCell(useHeaderRow, maxColumnIndex, headRows, startColumnIndex);
}
}
}
// row -> c, must after `if (nextRowIndex < rowIndex)` condition code, eg. The first empty row has no xml element,and the second row xml element is <row r="2"/>
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false) && !_config.IgnoreEmptyRows)
{
//Fill in case of self closed empty row tag eg. <row r="1"/>
yield return GetCell(useHeaderRow, maxColumnIndex, headRows, startColumnIndex);
yield break;
}
var cell = GetCell(useHeaderRow, maxColumnIndex, headRows, startColumnIndex);
var columnIndex = withoutCr ? -1 : 0;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "c", Ns))
{
var aS = reader.GetAttribute("s");
var aR = reader.GetAttribute("r");
var aT = reader.GetAttribute("t");
var cellAndColumn = await ReadCellAndSetColumnIndexAsync(reader, columnIndex, withoutCr, startColumnIndex, aR, aT, cancellationToken).ConfigureAwait(false);
var cellValue = cellAndColumn.CellValue;
columnIndex = cellAndColumn.ColumnIndex;
if (_config.FillMergedCells)
{
if (mergeCells?.MergesValues.ContainsKey(aR) ?? false)
{
mergeCells.MergesValues[aR] = cellValue;
}
else if (mergeCells?.MergesMap.TryGetValue(aR, out var mergeKey) ?? false)
{
mergeCells.MergesValues.TryGetValue(mergeKey, out cellValue);
}
}
if (columnIndex < startColumnIndex || columnIndex > endColumnIndex)
continue;
if (!string.IsNullOrEmpty(aS)) // if c with s meaning is custom style need to check type by xl/style.xml
{
int xfIndex = -1;
if (int.TryParse(aS, NumberStyles.Any, CultureInfo.InvariantCulture, out var styleIndex))
xfIndex = styleIndex;
// only when have s attribute then load styles xml data
_style ??= new OpenXmlStyles(Archive);
cellValue = _style.ConvertValueByStyleFormat(xfIndex, cellValue);
}
SetCellsValueAndHeaders(cellValue, useHeaderRow, headRows, isFirstRow, cell, columnIndex);
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
yield return cell;
}
private ZipArchiveEntry GetSheetEntry(string? sheetName)
{
// if sheets count > 1 need to read xl/_rels/workbook.xml.rels
var sheets = Archive.EntryCollection
.Where(w => w.FullName.StartsWith("xl/worksheets/sheet", StringComparison.OrdinalIgnoreCase) ||
w.FullName.StartsWith("/xl/worksheets/sheet", StringComparison.OrdinalIgnoreCase))
.ToArray();
ZipArchiveEntry sheetEntry;
if (sheetName is not null)
{
SetWorkbookRels(Archive.EntryCollection);
var sheetRecord = _sheetRecords.SingleOrDefault(s => s.Name == sheetName);
if (sheetRecord is null)
{
if (_config.DynamicSheets is null)
throw new InvalidOperationException("Please check that parameters sheetName/Index are correct");
var sheetConfig = _config.DynamicSheets.FirstOrDefault(ds => ds.Key == sheetName);
if (sheetConfig is not null)
{
sheetRecord = _sheetRecords.SingleOrDefault(s => s.Name == sheetConfig.Name);
}
}
sheetEntry = sheets.Single(w => w.FullName == $"xl/{sheetRecord.Path}" ||
w.FullName == $"/xl/{sheetRecord.Path}" ||
w.FullName == sheetRecord.Path ||
$"/{w.FullName}" == sheetRecord.Path);
}
else if (sheets.Length > 1)
{
SetWorkbookRels(Archive.EntryCollection);
var s = _sheetRecords[0];
sheetEntry = sheets.Single(w => w.FullName == $"xl/{s.Path}" ||
w.FullName == $"/xl/{s.Path}" ||
w.FullName.TrimStart('/') == s.Path?.TrimStart('/'));
}
else
{
sheetEntry = sheets.Single();
}
return sheetEntry;
}
private static IDictionary<string, object?> GetCell(bool useHeaderRow, int maxColumnIndex, Dictionary<int, string> headRows, int startColumnIndex)
{
return useHeaderRow
? ExpandoHelper.CreateEmptyByHeaders(headRows)
: ExpandoHelper.CreateEmptyByIndices(maxColumnIndex, startColumnIndex);
}
private static void SetCellsValueAndHeaders(object? cellValue, bool useHeaderRow, Dictionary<int, string> headRows, bool isFirstRow, IDictionary<string, object?> cell, int columnIndex)
{
if (!useHeaderRow)
{
//if not using First Head then using A,B,C as index
cell[CellReferenceConverter.GetAlphabeticalIndex(columnIndex)] = cellValue;
return;
}
if (isFirstRow) // for startcell logic
{
var cellValueString = cellValue?.ToString();
if (!string.IsNullOrWhiteSpace(cellValueString))
headRows.Add(columnIndex, cellValueString);
}
else if (headRows.TryGetValue(columnIndex, out var key))
{
cell[key] = cellValue;
}
}
[CreateSyncVersion]
private async Task SetSharedStringsAsync(CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
if (SharedStrings is { Count: > 0 })
return;
var sharedStringsEntry = Archive.GetEntry("xl/sharedStrings.xml");
if (sharedStringsEntry is null)
return;
var idx = 0;
#if NET10_0_OR_GREATER
var stream = await sharedStringsEntry.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableStream = stream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var stream = sharedStringsEntry.Open();
await using var disposableStream = stream.ConfigureAwait(false);
#else
using var stream = sharedStringsEntry.Open();
#endif
if (_config.EnableSharedStringCache && sharedStringsEntry.Length >= _config.SharedStringCacheSize)
{
SharedStrings = new SharedStringsDiskCache(_config.SharedStringCachePath);
await foreach (var sharedString in XmlReaderHelper.GetSharedStringsAsync(stream, cancellationToken, Ns).ConfigureAwait(false))
{
SharedStrings[idx++] = sharedString;
}
}
else if (SharedStrings is { Count: 0 })
{
var list = await XmlReaderHelper.GetSharedStringsAsync(stream, cancellationToken, Ns)
.CreateListAsync(cancellationToken)
.ConfigureAwait(false);
SharedStrings = list.ToDictionary(_ => idx++, x => x);
}
}
private void SetWorkbookRels(ReadOnlyCollection<ZipArchiveEntry> entries)
{
_sheetRecords ??= GetWorkbookRels(entries);
}
[CreateSyncVersion]
private static async IAsyncEnumerable<SheetRecord> ReadWorkbookAsync(ReadOnlyCollection<ZipArchiveEntry> entries, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
var xmlSettings = XmlReaderHelper.GetXmlReaderSettings(
#if SYNC_ONLY
false
#else
true
#endif
);
var entry = entries.Single(w => w.FullName == "xl/workbook.xml");
#if NET10_0_OR_GREATER
var stream = await entry.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableStream = stream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var stream = entry.Open();
await using var disposableStream = stream.ConfigureAwait(false);
#else
using var stream = entry.Open();
#endif
using var reader = XmlReader.Create(stream, xmlSettings);
if (!XmlReaderHelper.IsStartElement(reader, "workbook", Ns))
yield break;
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
yield break;
var activeSheetIndex = 0;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "bookViews", Ns))
{
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
continue;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "workbookView", Ns))
{
var activeSheet = reader.GetAttribute("activeTab");
if (int.TryParse(activeSheet, out var index))
{
activeSheetIndex = index;
}
await reader.SkipAsync()
#if NET6_0_OR_GREATER
.WaitAsync(cancellationToken)
#endif
.ConfigureAwait(false);
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
else if (XmlReaderHelper.IsStartElement(reader, "sheets", Ns))
{
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
continue;
var sheetCount = 0;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "sheet", Ns))
{
yield return new SheetRecord(
reader.GetAttribute("name"),
reader.GetAttribute("state"),
uint.Parse(reader.GetAttribute("sheetId")),
XmlReaderHelper.GetAttribute(reader, "id", RelationshiopNs),
sheetCount == activeSheetIndex
);
sheetCount++;
await reader.SkipAsync()
#if NET6_0_OR_GREATER
.WaitAsync(cancellationToken)
#endif
.ConfigureAwait(false);
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
yield break;
}
}
}
[CreateSyncVersion]
internal async Task<List<SheetRecord>?> GetWorkbookRelsAsync(ReadOnlyCollection<ZipArchiveEntry> entries, CancellationToken cancellationToken = default)
{
var xmlSettings = XmlReaderHelper.GetXmlReaderSettings(
#if SYNC_ONLY
false
#else
true
#endif
);
var sheetRecords = await ReadWorkbookAsync(entries, cancellationToken)
.CreateListAsync(cancellationToken)
.ConfigureAwait(false);
var entry = entries.Single(w => w.FullName == "xl/_rels/workbook.xml.rels");
#if NET10_0_OR_GREATER
var stream = await entry.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableStream = stream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var stream = entry.Open();
await using var disposableStream = stream.ConfigureAwait(false);
#else
using var stream = entry.Open();
#endif
using var reader = XmlReader.Create(stream, xmlSettings);
if (!XmlReaderHelper.IsStartElement(reader, "Relationships", Schemas.OpenXmlPackageRelationships))
return null;
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
return null;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "Relationship", Schemas.OpenXmlPackageRelationships))
{
var rid = reader.GetAttribute("Id");
foreach (var sheet in sheetRecords.Where(sh => sh.Rid == rid))
{
sheet.Path = reader.GetAttribute("Target");
break;
}
await reader.SkipAsync()
#if NET6_0_OR_GREATER
.WaitAsync(cancellationToken)
#endif
.ConfigureAwait(false);
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
return sheetRecords;
}
internal class CellAndColumn(object? cellValue, int columnIndex)
{
public object? CellValue { get; } = cellValue;
public int ColumnIndex { get; } = columnIndex;
}
[CreateSyncVersion]
private async Task<CellAndColumn> ReadCellAndSetColumnIndexAsync(XmlReader reader, int columnIndex, bool withoutCr, int startColumnIndex, string aR, string aT, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
const int xfIndex = -1;
int newColumnIndex;
if (withoutCr)
{
newColumnIndex = columnIndex + 1;
}
else if (CellReferenceConverter.TryParseCellReference(aR, out int referenceColumn, out _))
{
//TODO:need to check only need nextColumnIndex or columnIndex
newColumnIndex = referenceColumn - 1; // ParseReference is 1-based
}
else
{
newColumnIndex = columnIndex;
}
columnIndex = newColumnIndex;
if (columnIndex < startColumnIndex)
{
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
return new CellAndColumn(null, columnIndex);
while (!reader.EOF)
{
if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
break;
}
return new CellAndColumn(null, columnIndex);
}
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
return new CellAndColumn(null, columnIndex);
object? value = null;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "v", Ns))
{
var rawValue = await reader.ReadElementContentAsStringAsync()
#if NET6_0_OR_GREATER
.WaitAsync(cancellationToken)
#endif
.ConfigureAwait(false);
if (!string.IsNullOrEmpty(rawValue))
ConvertCellValue(rawValue, aT, xfIndex, out value);
}
else if (XmlReaderHelper.IsStartElement(reader, "is", Ns))
{
var rawValue = await XmlReaderHelper.ReadStringItemAsync(reader, cancellationToken).ConfigureAwait(false);
if (!string.IsNullOrEmpty(rawValue))
ConvertCellValue(rawValue, aT, xfIndex, out value);
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
return new CellAndColumn(value, columnIndex);
}
private void ConvertCellValue(string rawValue, string aT, int xfIndex, out object? value)
{
const NumberStyles style = NumberStyles.Any;
var invariantCulture = CultureInfo.InvariantCulture;
value = null;
switch (aT)
{
case "s":
if (int.TryParse(rawValue, style, invariantCulture, out var sstIndex))
{
if (sstIndex >= 0 && sstIndex < SharedStrings?.Count)
{
value = XmlHelper.DecodeString(SharedStrings[sstIndex]);
}
}
break;
case "inlineStr":
case "str":
//TODO: it will unbox,box
var v = XmlHelper.DecodeString(rawValue);
value = v;
if (_config.EnableConvertByteArray)
{
//if str start with "data:image/png;base64," then convert to byte[] https://github.com/mini-software/MiniExcel/issues/318
if (v?.StartsWith("@@@fileid@@@,", StringComparison.Ordinal) ?? false)
{
var path = v[13..];
var entry = Archive.GetEntry(path);
var bytes = new byte[entry.Length];
using (var stream = entry.Open())
using (var ms = new MemoryStream(bytes))
{
stream.CopyTo(ms);
}
value = bytes;
}
}
break;
case "b":
value = rawValue == "1";
return;
case "d":
value = DateTime.TryParseExact(rawValue, "yyyy-MM-dd", invariantCulture, DateTimeStyles.AllowLeadingWhite | DateTimeStyles.AllowTrailingWhite, out var date)
? date
: rawValue;
return;
case "e":
value = rawValue;
return;
default:
value = double.TryParse(rawValue, style, invariantCulture, out var n) ? n : rawValue;
return;
}
}
[CreateSyncVersion]
internal async Task<IList<ExcelRange>> GetDimensionsAsync(CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
var xmlSettings = XmlReaderHelper.GetXmlReaderSettings(
#if SYNC_ONLY
false
#else
true
#endif
);
var ranges = new List<ExcelRange>();
var sheets = Archive.EntryCollection.Where(e =>
e.FullName.StartsWith("xl/worksheets/sheet", StringComparison.OrdinalIgnoreCase) ||
e.FullName.StartsWith("/xl/worksheets/sheet", StringComparison.OrdinalIgnoreCase));
foreach (var sheet in sheets)
{
var maxRowIndex = -1;
var maxColumnIndex = -1;
string? startCell = null;
string? endCell = null;
var withoutCr = false;
#if NET10_0_OR_GREATER
var crSheetStream = await sheet.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableCrSheetStream = crSheetStream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var crSheetStream = sheet.Open();
await using var disposableCrSheetStream = crSheetStream.ConfigureAwait(false);
#else
using var crSheetStream = sheet.Open();
#endif
using (var reader = XmlReader.Create(crSheetStream, xmlSettings))
{
while (await reader.ReadAsync().ConfigureAwait(false))
{
if (XmlReaderHelper.IsStartElement(reader, "c", Ns))
{
var r = reader.GetAttribute("r");
if (r is not null)
{
if (CellReferenceConverter.TryParseCellReference(r, out var column, out var row))
{
column--;
row--;
maxRowIndex = Math.Max(maxRowIndex, row);
maxColumnIndex = Math.Max(maxColumnIndex, column);
}
}
else
{
withoutCr = true;
break;
}
}
else if (XmlReaderHelper.IsStartElement(reader, "dimension", Ns))
{
var refAttr = reader.GetAttribute("ref");
if (string.IsNullOrEmpty(refAttr))
throw new InvalidDataException("No dimension data found for the sheet");
var rs = refAttr.Split(':');
if (!CellReferenceConverter.TryParseCellReference(rs.Length == 2 ? rs[1] : rs[0], out var col, out var row))
throw new InvalidDataException("The dimensions of the sheet are invalid");
maxColumnIndex = col;
maxRowIndex = row;
startCell = rs[0];
endCell = rs[1];
break;
}
}
}
if (withoutCr)
{
#if NET10_0_OR_GREATER
var sheetStream = await sheet.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableSheetStream = sheetStream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var sheetStream = sheet.Open();
await using var disposableSheetStream = sheetStream.ConfigureAwait(false);
#else
using var sheetStream = sheet.Open();
#endif
using var reader = XmlReader.Create(sheetStream, xmlSettings);
if (!XmlReaderHelper.IsStartElement(reader, "worksheet", Ns))
throw new InvalidDataException("No worksheet data found for the sheet");
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
throw new InvalidOperationException("Excel sheet does not contain any data");
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "sheetData", Ns))
{
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
continue;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "row", Ns))
{
maxRowIndex++;
if (!await XmlReaderHelper.ReadFirstContentAsync(reader, cancellationToken).ConfigureAwait(false))
continue;
var cellIndex = -1;
while (!reader.EOF)
{
if (XmlReaderHelper.IsStartElement(reader, "c", Ns))
{
cellIndex++;
maxColumnIndex = Math.Max(maxColumnIndex, cellIndex);
}
if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
break;
}
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
else if (!await XmlReaderHelper.SkipContentAsync(reader, cancellationToken).ConfigureAwait(false))
{
break;
}
}
}
var range = new ExcelRange(maxRowIndex, maxColumnIndex)
{
StartCell = startCell,
EndCell = endCell
};
ranges.Add(range);
}
return ranges;
}
internal class GetMaxRowColumnIndexResult(bool isSuccess)
{
public bool IsSuccess { get; } = isSuccess;
public bool WithoutCr { get; }
public int MaxRowIndex { get; } = -1;
public int MaxColumnIndex { get; } = -1;
public GetMaxRowColumnIndexResult(bool isSuccess, bool withoutCr, int maxRowIndex, int maxColumnIndex)
: this(isSuccess)
{
WithoutCr = withoutCr;
MaxRowIndex = maxRowIndex;
MaxColumnIndex = maxColumnIndex;
}
}
[CreateSyncVersion]
internal static async Task<GetMaxRowColumnIndexResult> TryGetMaxRowColumnIndexAsync(ZipArchiveEntry sheetEntry, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
var xmlSettings = XmlReaderHelper.GetXmlReaderSettings(
#if SYNC_ONLY
false
#else
true
#endif
);
bool withoutCr = false;
int maxRowIndex = -1;
int maxColumnIndex = -1;
#if NET10_0_OR_GREATER
var crSheetStream = await sheetEntry.OpenAsync(cancellationToken).ConfigureAwait(false);
await using var disposableCrSheetStream = crSheetStream.ConfigureAwait(false);
#elif !NETSTANDARD2_0
var crSheetStream = sheetEntry.Open();
await using var disposableCrSheetStream = crSheetStream.ConfigureAwait(false);
#else
using var crSheetStream = sheetEntry.Open();
#endif
using (var reader = XmlReader.Create(crSheetStream, xmlSettings))
{
while (await reader.ReadAsync()
#if NET6_0_OR_GREATER
.WaitAsync(cancellationToken)
#endif
.ConfigureAwait(false))
{
if (XmlReaderHelper.IsStartElement(reader, "c", Ns))
{
var r = reader.GetAttribute("r");
if (r is not null)
{
if (CellReferenceConverter.TryParseCellReference(r, out var column, out var row))
{
column--;
row--;
maxRowIndex = Math.Max(maxRowIndex, row);
maxColumnIndex = Math.Max(maxColumnIndex, column);
}
}
else
{
withoutCr = true;
break;
}
}
//this method logic depends on dimension to get maxcolumnIndex, if without dimension then it need to foreach all rows first time to get maxColumn and maxRowColumn
else if (XmlReaderHelper.IsStartElement(reader, "dimension", Ns))
{
var refAttr = reader.GetAttribute("ref");
if (string.IsNullOrEmpty(refAttr))
throw new InvalidDataException("No dimension data found for the sheet");
var rs = refAttr.Split(':');
// issue : https://github.com/mini-software/MiniExcel/issues/102
if (!CellReferenceConverter.TryParseCellReference(rs.Length == 2 ? rs[1] : rs[0], out int cIndex, out int rIndex))
throw new InvalidDataException("The dimensions of the sheet are invalid");
maxRowIndex = rIndex - 1;
maxColumnIndex = cIndex - 1;
break;
}
}
}
if (withoutCr)