Compare commits

...
Author SHA1 Message Date
Dylan M. Taylor f085cea83c test(xlsb): cover external sheetData cell types and definedName attributes for SonarCloud 2026-11-20 14:49:06 -05:00
Dylan M. Taylor 544a50c5cf xlsx: preserve external workbook target relationships on XLSB -> XLSX save (#4596)
* xlsx: preserve external workbook target relationships on XLSB -> XLSX save

* fix(xlsb): format CellRef with Display instead of nonexistent to_a1

* xlsx: preserve external link ordinals across missing slots on XLSB -> XLSX save
2026-11-20 14:41:44 -05:00
2 changed files with 263 additions and 2 deletions
+147 -1
View File
@@ -467,10 +467,35 @@ fn xlsb_external_book_formulas_and_names_decode_and_roundtrip_through_xlsx() {
tabs.extend(wide("Other Sheet"));
ext_bin.extend(record(359, &tabs));
ext_bin.extend(record(577, &wide("ExtName")));
// BrtSupNameFmla (585): ExtPtgRef3D (0x3A, sheet 0..0, r=0, c=0)
let mut fmla_payload = 9u32.to_le_bytes().to_vec();
fmla_payload.push(0x3A);
fmla_payload.extend(0u16.to_le_bytes());
fmla_payload.extend(0u16.to_le_bytes());
fmla_payload.extend(0u16.to_le_bytes());
fmla_payload.extend(0u16.to_le_bytes());
ext_bin.extend(record(585, &fmla_payload));
let mut bits = vec![0u8; 7];
bits[2..6].copy_from_slice(&0u32.to_le_bytes());
ext_bin.extend(record(586, &bits));
ext_bin.extend(record(587, &[]));
// Sheet-scoped external name ("LocalExt" on sheet 1 -> sheetId="0")
ext_bin.extend(record(577, &wide("LocalExt")));
let mut local_bits = vec![0u8; 7];
local_bits[2..6].copy_from_slice(&1u32.to_le_bytes());
ext_bin.extend(record(586, &local_bits));
ext_bin.extend(record(587, &[]));
// BrtExternTableStart (363) with refreshError=1, row 0, and all 5 cell types.
let mut t_start = 0u32.to_le_bytes().to_vec();
t_start.push(1);
ext_bin.extend(record(363, &t_start));
ext_bin.extend(record(366, &0u32.to_le_bytes()));
ext_bin.extend(record(367, &0u32.to_le_bytes()));
ext_bin.extend(record(368, &[&1u32.to_le_bytes()[..], &4.5f64.to_le_bytes()[..]].concat()));
ext_bin.extend(record(369, &[&2u32.to_le_bytes()[..], &[1u8]].concat()));
ext_bin.extend(record(370, &[&3u32.to_le_bytes()[..], &[0x07u8]].concat()));
ext_bin.extend(record(371, &[&4u32.to_le_bytes()[..], &wide("hi")[..]].concat()));
ext_bin.extend(record(364, &[]));
ext_bin.extend(record(588, &[]));
let fmla_num = |col: u32, cached: f64, rgce: &[u8]| {
@@ -521,9 +546,130 @@ fn xlsb_external_book_formulas_and_names_decode_and_roundtrip_through_xlsx() {
assert_eq!(c1.value, Value::Number(12.5));
assert_eq!(c1.formula.as_ref().map(|f| f.text.as_str()), Some("[1]!ExtName"));
let (rt, _) = read_xlsx(&write_xlsx(&wb).unwrap()).unwrap();
let saved = write_xlsx(&wb).unwrap();
let (rt, _) = read_xlsx(&saved).unwrap();
assert_eq!(rt.sheets[0].cell(CellRef::new(0, 0)).and_then(|c| c.formula.as_ref()).map(|f| f.text.as_str()), Some("[1]Data!$A$1"));
assert_eq!(rt.sheets[0].value(CellRef::new(0, 0)), Value::Number(99.0));
assert_eq!(rt.sheets[0].cell(CellRef::new(0, 1)).and_then(|c| c.formula.as_ref()).map(|f| f.text.as_str()), Some("[1]!ExtName"));
assert_eq!(rt.sheets[0].value(CellRef::new(0, 1)), Value::Number(12.5));
// Verify the external workbook target relationship survives XLSB -> XLSX -> read_xlsx -> XLSX.
let saved2 = write_xlsx(&rt).unwrap();
let mut zip = zip::ZipArchive::new(std::io::Cursor::new(saved2)).unwrap();
let read_zip = |z: &mut zip::ZipArchive<std::io::Cursor<Vec<u8>>>, name: &str| {
let mut s = String::new();
std::io::Read::read_to_string(&mut z.by_name(name).unwrap(), &mut s).unwrap();
s
};
let wb_xml = read_zip(&mut zip, "xl/workbook.xml");
assert!(wb_xml.contains("<externalReferences"), "{wb_xml}");
let wb_rels = read_zip(&mut zip, "xl/_rels/workbook.xml.rels");
let link_target = wb_rels
.split("<Relationship ")
.find(|r| r.contains("externalLink\""))
.and_then(|r| r.split("Target=\"").nth(1))
.and_then(|s| s.split('"').next())
.expect("workbook.xml.rels should have an externalLink relationship")
.trim_start_matches('/')
.to_string();
let link_part = if link_target.starts_with("xl/") { link_target } else { format!("xl/{link_target}") };
let link_xml = read_zip(&mut zip, &link_part);
assert!(link_xml.contains("<sheetName val=\"Data\"/>") && link_xml.contains("name=\"ExtName\""), "{link_xml}");
let (dir, file) = link_part.rsplit_once('/').unwrap();
let link_rels_xml = read_zip(&mut zip, &format!("{dir}/_rels/{file}.rels"));
assert!(
link_rels_xml.contains("externalLinkPath")
&& link_rels_xml.contains("Target=\"Book2.xlsx\"")
&& link_rels_xml.contains("TargetMode=\"External\""),
"{link_rels_xml}"
);
}
#[test]
fn xlsb_external_link_ordinals_preserve_missing_slots_on_xlsx_save() {
let mut wb_records = record(131, &[]);
let mut props = 0u32.to_le_bytes().to_vec();
props.extend(0u32.to_le_bytes());
props.extend(wide(""));
wb_records.extend(record(153, &props));
wb_records.extend(record(143, &[]));
let mut s1 = 0u32.to_le_bytes().to_vec();
s1.extend(1u32.to_le_bytes());
s1.extend(wide("one"));
s1.extend(wide("Data"));
wb_records.extend(record(156, &s1));
wb_records.extend(record(144, &[]));
// Book 0 = self, Book 1 = missing ("missing"), Book 2 = valid ("ext2").
wb_records.extend(record(357, &[]));
wb_records.extend(record(355, &wide("missing")));
wb_records.extend(record(355, &wide("ext2")));
let mut xti = 2u32.to_le_bytes().to_vec();
for (bk, first, last) in [(1u32, 0i32, 0i32), (2, 0, 0)] {
xti.extend(bk.to_le_bytes());
xti.extend(first.to_le_bytes());
xti.extend(last.to_le_bytes());
}
wb_records.extend(record(362, &xti));
wb_records.extend(record(132, &[]));
let mut ext_bin = Vec::new();
let mut begin_sup = 0u16.to_le_bytes().to_vec();
begin_sup.extend(wide("rId1"));
begin_sup.extend(u32::MAX.to_le_bytes());
ext_bin.extend(record(360, &begin_sup));
let mut tabs = 1u32.to_le_bytes().to_vec();
tabs.extend(wide("SheetA"));
ext_bin.extend(record(359, &tabs));
ext_bin.extend(record(588, &[]));
let fmla_num = |col: u32, cached: f64, rgce: &[u8]| {
let mut data = col.to_le_bytes().to_vec();
data.extend([0; 4]);
data.extend(cached.to_le_bytes());
data.extend([0; 2]);
data.extend((rgce.len() as u32).to_le_bytes());
data.extend(rgce);
data.extend(0u32.to_le_bytes());
record(9, &data)
};
let ptg_1 = {
let mut v = vec![0x3A, 0, 0];
v.extend(0u32.to_le_bytes());
v.extend(0u16.to_le_bytes());
v
};
let ptg_2 = {
let mut v = vec![0x3A, 1, 0];
v.extend(0u32.to_le_bytes());
v.extend(0u16.to_le_bytes());
v
};
let mut data = row(0);
data.extend(fmla_num(0, 11.0, &ptg_1));
data.extend(fmla_num(1, 22.0, &ptg_2));
let rels = r#"<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="one" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="../data/one.bin"/><Relationship Id="strings" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings" Target="../text/strings.bin"/><Relationship Id="ext2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/externalLink" Target="../links/externalLink2.bin"/></Relationships>"#;
let types = r#"<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Override PartName="/records/book.bin" ContentType="application/vnd.ms-excel.sheet.binary.macroEnabled.main"/><Override PartName="/data/one.bin" ContentType="application/vnd.ms-excel.worksheet"/><Override PartName="/text/strings.bin" ContentType="application/vnd.ms-excel.sharedStrings"/><Override PartName="/links/externalLink2.bin" ContentType="application/vnd.ms-excel.externalLink"/></Types>"#;
let link_rels = r#"<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/externalLinkPath" Target="SecondBook.xlsx" TargetMode="External"/></Relationships>"#;
let bytes = make_zip(&[
("[Content_Types].xml", types.as_bytes()),
("_rels/.rels", ROOT.as_bytes()),
("records/book.bin", &wb_records),
("records/_rels/book.bin.rels", rels.as_bytes()),
("data/one.bin", &worksheet(&data, &[])),
("text/strings.bin", &sst()),
("links/externalLink2.bin", &ext_bin),
("links/_rels/externalLink2.bin.rels", link_rels.as_bytes()),
]);
let (wb, report) = read_xlsb(&bytes).unwrap();
assert!(report.warnings.iter().any(|w| w.contains("external link")), "{:?}", report.warnings);
assert!(wb.sheets[0].cell(CellRef::new(0, 0)).is_some_and(|c| c.formula.is_none() && c.value == Value::Number(11.0)));
assert_eq!(wb.sheets[0].cell(CellRef::new(0, 1)).and_then(|c| c.formula.as_ref()).map(|f| f.text.as_str()), Some("[2]SheetA!$A$1"));
let saved = write_xlsx(&wb).unwrap();
let mut zip = zip::ZipArchive::new(std::io::Cursor::new(saved)).unwrap();
let mut wb_xml = String::new();
std::io::Read::read_to_string(&mut zip.by_name("xl/workbook.xml").unwrap(), &mut wb_xml).unwrap();
assert!(wb_xml.contains("<externalReference/><externalReference r:id="), "{wb_xml}");
}
+116 -1
View File
@@ -2,11 +2,15 @@
//! Cell values, formulas, defined names, and merged cells are imported; formatting, charts,
//! images, macros and other workbook features are not imported.
use std::collections::BTreeMap;
use std::fmt::Write as _;
use std::sync::Arc;
use gridcraft_core::{CellError, CellRef, DateSystem, RangeRef, Value};
use gridcraft_model::{Cell, DefinedName, Formula, Sheet, StyleId, Visibility, Workbook};
use gridcraft_model::{Cell, DefinedName, Formula, Preserved, PreservedPart, PreservedRel, PreservedXml, Sheet, StyleId, Visibility, Workbook};
use crate::write::{NS_MAIN, NS_REL, XML_DECL};
use crate::xml::{esc, esc_attr};
use crate::{IoError, ReadReport};
fn map_error(err: craft_xlsx::Error) -> IoError {
@@ -189,6 +193,10 @@ pub fn read_xlsb(bytes: &[u8]) -> Result<(Workbook, ReadReport), IoError> {
wb.sheets.push(Arc::new(sheet));
}
import_defined_names(&book, &file_to_model, &mut wb);
let external_links = package.external_links(&book).map_err(map_error)?;
if let Some(preserved) = preserve_external_links(&external_links) {
wb.preserved = Some(Arc::new(preserved));
}
for warning in package.warnings() {
report.warn(warning);
}
@@ -202,3 +210,110 @@ pub fn read_xlsb(bytes: &[u8]) -> Result<(Workbook, ReadReport), IoError> {
pub(crate) fn is_xlsb(bytes: &[u8]) -> bool {
craft_xlsx::is_xlsb(bytes)
}
fn preserve_external_links(links: &[(String, Option<craft_xlsx::ExternalLink>)]) -> Option<Preserved> {
if links.is_empty() {
return None;
}
const CT_EXT_LINK: &str = "application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml";
let mut p = Preserved::default();
let mut refs_xml = format!("<externalReferences xmlns:r=\"{NS_REL}\">");
let mut has_any = false;
for (i, (_, link)) in links.iter().enumerate() {
let Some(link) = link else {
// Preserve the 1-based `[n]` ordinal for later links when an earlier slot is missing.
refs_xml.push_str("<externalReference/>");
continue;
};
has_any = true;
let rid = format!("rId{}", i + 1);
let part_name = format!("xl/externalLinks/externalLink{}.xml", i + 1);
let (xml, rels) = external_link_part_xml(link);
p.rels.push(PreservedRel { id: rid.clone(), rel_type: format!("{NS_REL}/externalLink"), target: part_name.clone(), external: false });
p.parts.push(PreservedPart { name: part_name, content_type: CT_EXT_LINK.into(), data: xml.into_bytes().into(), rels });
let _ = write!(refs_xml, "<externalReference r:id=\"{rid}\"/>");
}
if !has_any {
return None;
}
refs_xml.push_str("</externalReferences>");
p.elements.push(PreservedXml { slot: "externalReferences".into(), xml: refs_xml });
Some(p)
}
fn external_link_part_xml(link: &craft_xlsx::ExternalLink) -> (String, Vec<PreservedRel>) {
let mut xml = format!("{XML_DECL}<externalLink xmlns=\"{NS_MAIN}\" xmlns:r=\"{NS_REL}\">");
let mut rels = Vec::new();
if let craft_xlsx::ExternalLink::Book(book) = link {
xml.push_str("<externalBook");
if let Some(target) = &book.target {
xml.push_str(" r:id=\"rId1\"");
rels.push(PreservedRel { id: "rId1".into(), rel_type: format!("{NS_REL}/externalLinkPath"), target: target.clone(), external: true });
}
xml.push('>');
if !book.sheet_names.is_empty() {
xml.push_str("<sheetNames>");
for name in &book.sheet_names {
let _ = write!(xml, "<sheetName val=\"{}\"/>", esc_attr(name));
}
xml.push_str("</sheetNames>");
}
if !book.defined_names.is_empty() {
xml.push_str("<definedNames>");
for dn in &book.defined_names {
let _ = write!(xml, "<definedName name=\"{}\"", esc_attr(&dn.name));
if let Some(refers_to) = &dn.refers_to {
let _ = write!(xml, " refersTo=\"{}\"", esc_attr(refers_to));
}
if let Some(sheet_id) = dn.sheet_id {
let _ = write!(xml, " sheetId=\"{sheet_id}\"");
}
xml.push_str("/>");
}
xml.push_str("</definedNames>");
}
if !book.sheet_data.is_empty() {
xml.push_str("<sheetDataSet>");
for sd in &book.sheet_data {
let _ = write!(xml, "<sheetData sheetId=\"{}\"", sd.sheet_id);
if sd.refresh_error {
xml.push_str(" refreshError=\"1\"");
}
xml.push('>');
let mut rows: BTreeMap<u32, Vec<(craft_xlsx::CellRef, &craft_xlsx::Value)>> = BTreeMap::new();
for (pos, val) in &sd.cells {
rows.entry(pos.row).or_default().push((*pos, val));
}
for (r, cells) in rows {
let _ = write!(xml, "<row r=\"{}\">", r + 1);
for (pos, val) in cells {
let r_attr = CellRef::new(pos.row, pos.col);
match val {
craft_xlsx::Value::Empty => {
let _ = write!(xml, "<cell r=\"{r_attr}\"/>");
}
craft_xlsx::Value::Number(n) => {
let _ = write!(xml, "<cell r=\"{r_attr}\"><v>{n}</v></cell>");
}
craft_xlsx::Value::Text(t) => {
let _ = write!(xml, "<cell r=\"{r_attr}\" t=\"str\"><v>{}</v></cell>", esc(t));
}
craft_xlsx::Value::Bool(b) => {
let _ = write!(xml, "<cell r=\"{r_attr}\" t=\"b\"><v>{}</v></cell>", if *b { "1" } else { "0" });
}
craft_xlsx::Value::Error(e) => {
let _ = write!(xml, "<cell r=\"{r_attr}\" t=\"e\"><v>{}</v></cell>", esc(map_cell_error(*e).as_str()));
}
}
}
xml.push_str("</row>");
}
xml.push_str("</sheetData>");
}
xml.push_str("</sheetDataSet>");
}
xml.push_str("</externalBook>");
}
xml.push_str("</externalLink>");
(xml, rels)
}