mirror of
https://github.com/storytold/gridcraft.git
synced 2026-11-11 04:50:23 -06:00
Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f15c73cc1 | ||
|
|
ccaa50b772 | ||
|
|
9d1ccdca31 | ||
|
|
3badcb0b74 | ||
|
|
0fc6a87d87 |
@@ -112,19 +112,9 @@ pub(super) fn find(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
Ok(json!({"cell": c.a1(), "sheet": si, "value": t, "count": hits.len()}))
|
||||
}
|
||||
|
||||
/// Most characters a cell holds (Excel's limit).
|
||||
const REPLACE_CELL_MAX_CHARS: usize = 32_767;
|
||||
/// Longest text one replacement may give a cell, in bytes: the character limit, each up to four
|
||||
/// bytes. Every occurrence copies the replacement text, so a short cell full of matches and a
|
||||
/// long replacement would otherwise expand to gigabytes. The character limit is checked on what
|
||||
/// fits in this.
|
||||
const REPLACE_CELL_MAX_BYTES: usize = REPLACE_CELL_MAX_CHARS * 4;
|
||||
/// Most bytes of replaced text one Replace All builds across all its cells.
|
||||
const REPLACE_TOTAL_MAX_BYTES: usize = 256 * 1024 * 1024;
|
||||
|
||||
pub(super) fn replace(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let what = str_param(p, "what").unwrap_or("").to_string();
|
||||
let with = str_param(p, "with").unwrap_or("");
|
||||
let with = str_param(p, "with").unwrap_or("").to_string();
|
||||
if what.is_empty() {
|
||||
return Err(bad("edit.replace", "missing `what`"));
|
||||
}
|
||||
@@ -138,7 +128,6 @@ pub(super) fn replace(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let n = edit(s, |cx| {
|
||||
let sheets: Vec<usize> = if workbook { (0..cx.wb.sheets.len()).collect() } else { vec![cx.wb.active_sheet()] };
|
||||
let mut n = 0;
|
||||
let mut total = 0usize;
|
||||
for si in sheets {
|
||||
let cells: Vec<(CellRef, String)> =
|
||||
cx.wb.sheet(si).map(|sh| sh.cells.iter().map(|(c, _)| (c, sh.input_text(c))).collect()).unwrap_or_default();
|
||||
@@ -150,20 +139,12 @@ pub(super) fn replace(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
continue;
|
||||
}
|
||||
let new = if whole {
|
||||
(with.len() <= REPLACE_CELL_MAX_BYTES).then(|| with.to_string())
|
||||
with.clone()
|
||||
} else if case {
|
||||
replace_cs_within(&text, &what, with, REPLACE_CELL_MAX_BYTES)
|
||||
text.replace(&what, &with)
|
||||
} else {
|
||||
replace_ci_within(&text, &what, with, REPLACE_CELL_MAX_BYTES)
|
||||
replace_ci(&text, &what, &with)
|
||||
};
|
||||
let new = new.filter(|n| n.chars().count() <= REPLACE_CELL_MAX_CHARS);
|
||||
let Some(new) = new else {
|
||||
return Err(EngineError::Other(format!("The replacement makes the text of {} too long.", c.a1())));
|
||||
};
|
||||
total = total.saturating_add(new.len());
|
||||
if total > REPLACE_TOTAL_MAX_BYTES {
|
||||
return Err(EngineError::Other("The replacements make too much text. Replace in a smaller range.".into()));
|
||||
}
|
||||
// A Python cell's text is its code: the replacement edits the code and the cell
|
||||
// stays a Python cell. Code that would no longer fit in a PY formula is left as it was.
|
||||
let old_py = cx.wb.sheet(si).and_then(|sh| sh.cell(c)).and_then(|x| x.py.clone());
|
||||
@@ -218,37 +199,7 @@ fn folds_in_place(s: &str) -> bool {
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn replace_ci(text: &str, what: &str, with: &str) -> String {
|
||||
replace_ci_within(text, what, with, usize::MAX).unwrap_or_default()
|
||||
}
|
||||
|
||||
/// `text` with every `what` replaced by `with`, or `None` once the result passes `limit` bytes
|
||||
/// (checked before each copy, so nothing larger is allocated).
|
||||
pub(super) fn replace_cs_within(text: &str, what: &str, with: &str, limit: usize) -> Option<String> {
|
||||
if what.is_empty() {
|
||||
return (text.len() <= limit).then(|| text.to_string());
|
||||
}
|
||||
let mut out = String::new();
|
||||
let mut i = 0;
|
||||
for (pos, m) in text.match_indices(what) {
|
||||
if out.len() + (pos - i) + with.len() > limit {
|
||||
return None;
|
||||
}
|
||||
out.push_str(text.get(i..pos).unwrap_or(""));
|
||||
out.push_str(with);
|
||||
i = pos + m.len();
|
||||
}
|
||||
let rest = text.get(i..).unwrap_or("");
|
||||
if out.len() + rest.len() > limit {
|
||||
return None;
|
||||
}
|
||||
out.push_str(rest);
|
||||
Some(out)
|
||||
}
|
||||
|
||||
/// Case-insensitive [`replace_cs_within`].
|
||||
pub(super) fn replace_ci_within(text: &str, what: &str, with: &str, limit: usize) -> Option<String> {
|
||||
let lower = text.to_lowercase();
|
||||
let w = what.to_lowercase();
|
||||
// Slicing `text` at positions found in `lower` is only sound when folding kept every byte
|
||||
@@ -256,22 +207,15 @@ pub(super) fn replace_ci_within(text: &str, what: &str, with: &str, limit: usize
|
||||
// boundaries (U+212A KELVIN SIGN shrinks 3→1 bytes, U+0130 grows 2→3), where the tail used
|
||||
// to be dropped. Those fall back to the case-sensitive replace, as length changes already do.
|
||||
if lower.len() != text.len() || w.is_empty() || !folds_in_place(text) || !folds_in_place(what) {
|
||||
return replace_cs_within(text, what, with, limit);
|
||||
return text.replace(what, with);
|
||||
}
|
||||
let mut out = String::new();
|
||||
let mut i = 0;
|
||||
while let Some(pos) = lower.get(i..).and_then(|s| s.find(&w)) {
|
||||
if out.len() + pos + with.len() > limit {
|
||||
return None;
|
||||
}
|
||||
out.push_str(text.get(i..i + pos).unwrap_or(""));
|
||||
out.push_str(with);
|
||||
i += pos + w.len();
|
||||
}
|
||||
let rest = text.get(i..).unwrap_or("");
|
||||
if out.len() + rest.len() > limit {
|
||||
return None;
|
||||
}
|
||||
out.push_str(rest);
|
||||
Some(out)
|
||||
out.push_str(text.get(i..).unwrap_or(""));
|
||||
out
|
||||
}
|
||||
|
||||
@@ -446,50 +446,6 @@ fn drag_and_drop_on_another_sheet_stays_on_that_sheet() {
|
||||
assert_eq!(wb.sheet(two).unwrap().value(CellRef::new(0, 1)), Value::Empty);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replace_refuses_text_that_would_grow_past_a_cell() {
|
||||
// 10,000 matches × a 1,000-character replacement would make a 10 MB cell (and a few such
|
||||
// cells gigabytes); the replacement is refused before that text is built.
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
let long = "a".repeat(10_000);
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [[long.clone()], ["abc"]]})).unwrap();
|
||||
for case in [false, true] {
|
||||
let err = s.execute("edit.replace", json!({"what": "a", "with": "x".repeat(1_000), "matchCase": case})).expect_err("too long");
|
||||
assert!(err.to_string().contains("too long"), "{err}");
|
||||
assert_eq!(s.execute("cell.get", json!({"cell": "A1"})).unwrap()["value"], json!(long));
|
||||
assert_eq!(s.execute("cell.get", json!({"cell": "A2"})).unwrap()["value"], json!("abc"));
|
||||
}
|
||||
// A replacement that stays within a cell's limit still happens.
|
||||
s.execute("edit.replace", json!({"what": "b", "with": "x".repeat(100)})).unwrap();
|
||||
assert_eq!(s.execute("cell.get", json!({"cell": "A2"})).unwrap()["value"], json!(format!("a{}c", "x".repeat(100))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replace_refuses_a_result_past_the_character_limit_though_it_fits_the_byte_limit() {
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["z"]]})).unwrap();
|
||||
for whole in [false, true] {
|
||||
let err = s.execute("edit.replace", json!({"what": "z", "with": "x".repeat(32_768), "wholeCell": whole})).expect_err("32,768 characters");
|
||||
assert!(err.to_string().contains("too long"), "{err}");
|
||||
assert_eq!(s.execute("cell.get", json!({"cell": "A1"})).unwrap()["value"], json!("z"));
|
||||
}
|
||||
s.execute("edit.replace", json!({"what": "z", "with": "x".repeat(32_767)})).unwrap();
|
||||
assert_eq!(s.execute("cell.get", json!({"cell": "A1"})).unwrap()["value"], json!("x".repeat(32_767)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bounded_replace_stops_at_its_limit() {
|
||||
use super::find::{replace_ci_within, replace_cs_within};
|
||||
assert_eq!(replace_cs_within("abab", "a", "xy", 6).as_deref(), Some("xybxyb"));
|
||||
assert_eq!(replace_cs_within("abab", "a", "xy", 5), None);
|
||||
assert_eq!(replace_ci_within("AbAb", "a", "xy", 6).as_deref(), Some("xybxyb"));
|
||||
assert_eq!(replace_ci_within("AbAb", "a", "xy", 5), None);
|
||||
assert_eq!(replace_cs_within("abc", "z", "", 3).as_deref(), Some("abc"));
|
||||
assert_eq!(replace_cs_within("abc", "z", "", 2), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replace_case_insensitive() {
|
||||
assert_eq!(replace_ci("Apple apple APPLE", "apple", "pear"), "pear pear pear");
|
||||
|
||||
@@ -42,15 +42,6 @@ pub(super) fn table_resize(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
})
|
||||
}
|
||||
|
||||
/// Most cells (rows × columns, blanks included) Get Data imports. The rows are built densely
|
||||
/// before they are written, so a few sparse records or one far-away CSV cell must not expand
|
||||
/// into a rectangle of billions of slots.
|
||||
const MAX_IMPORT_CELLS: u64 = 10_000_000;
|
||||
|
||||
fn too_many_cells() -> EngineError {
|
||||
EngineError::Other(format!("The data is too large to import ({MAX_IMPORT_CELLS} cells at most)."))
|
||||
}
|
||||
|
||||
pub(super) fn from_csv(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let bytes = if let Some(t) = str_param(p, "text") {
|
||||
t.as_bytes().to_vec()
|
||||
@@ -66,27 +57,15 @@ pub(super) fn from_csv(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
if text.trim_start().starts_with('[') {
|
||||
let arr: Vec<Json> = serde_json::from_str(&text).map_err(|e| bad("data.getData", e.to_string()))?;
|
||||
let mut keys: Vec<String> = Vec::new();
|
||||
let mut seen: std::collections::HashSet<&str> = std::collections::HashSet::new();
|
||||
for o in &arr {
|
||||
if let Some(m) = o.as_object() {
|
||||
for k in m.keys() {
|
||||
if !seen.contains(k.as_str()) {
|
||||
// Stop collecting at the column limit.
|
||||
if keys.len() >= gridcraft_core::MAX_COLS as usize {
|
||||
return Err(EngineError::Other("The data has more fields than a sheet has columns.".into()));
|
||||
}
|
||||
seen.insert(k.as_str());
|
||||
if !keys.contains(k) {
|
||||
keys.push(k.clone());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if arr.len() as u64 + 1 > u64::from(gridcraft_core::MAX_ROWS) {
|
||||
return Err(EngineError::Other("The data has more rows than a sheet has.".into()));
|
||||
}
|
||||
if (arr.len() as u64 + 1).saturating_mul(keys.len().max(1) as u64) > MAX_IMPORT_CELLS {
|
||||
return Err(too_many_cells());
|
||||
}
|
||||
let mut out = vec![keys.iter().map(|k| json!(k)).collect::<Vec<_>>()];
|
||||
for o in &arr {
|
||||
out.push(keys.iter().map(|k| o.get(k).cloned().unwrap_or(Json::Null)).collect());
|
||||
@@ -96,17 +75,10 @@ pub(super) fn from_csv(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let delim = str_param(p, "delimiter")
|
||||
.and_then(|d| d.chars().next())
|
||||
.unwrap_or(if text.lines().next().is_some_and(|l| l.contains('\t')) { '\t' } else { ',' });
|
||||
let opts = gridcraft_xlsx::CsvOptions { delimiter: delim as u8, max_used_cells: Some(MAX_IMPORT_CELLS), ..Default::default() };
|
||||
// The cell limit is enforced while parsing, before an oversized file is stored.
|
||||
let wb = gridcraft_xlsx::read_csv(&bytes, &opts).map_err(|e| match e {
|
||||
gridcraft_xlsx::IoError::TooLarge(_) => too_many_cells(),
|
||||
e => EngineError::Other(e.to_string()),
|
||||
})?;
|
||||
let opts = gridcraft_xlsx::CsvOptions { delimiter: delim as u8, ..Default::default() };
|
||||
let wb = gridcraft_xlsx::read_csv(&bytes, &opts).map_err(|e| EngineError::Other(e.to_string()))?;
|
||||
let sh = wb.sheet(0).ok_or(EngineError::NoDocument)?;
|
||||
let Some(u) = sh.used_range() else { return Err(EngineError::Other("The file is empty.".into())) };
|
||||
if u.count() > MAX_IMPORT_CELLS {
|
||||
return Err(too_many_cells());
|
||||
}
|
||||
(u.start.row..=u.end.row)
|
||||
.map(|r| {
|
||||
(u.start.col..=u.end.col)
|
||||
@@ -157,35 +129,3 @@ pub(super) fn queries(s: &mut Session, _: &Json) -> Result<Json> {
|
||||
.collect(),
|
||||
))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use serde_json::json;
|
||||
|
||||
use crate::Session;
|
||||
|
||||
fn s() -> Session {
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
s
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sparse_imports_are_refused_before_their_rows_are_built() {
|
||||
let mut s = s();
|
||||
let sheets = s.doc().unwrap().wb.sheets.len();
|
||||
// 5,000 records with one field each: 5,001 × 5,000 slots once every record gets every field.
|
||||
let records: Vec<_> = (0..5_000).map(|i| json!({ format!("k{i}"): i })).collect();
|
||||
let text = serde_json::to_string(&records).unwrap();
|
||||
let err = s.execute("data.getData", json!({"text": text})).expect_err("too many cells");
|
||||
assert!(err.to_string().contains("too large"), "{err}");
|
||||
// A CSV whose last line reaches 16,001 columns, 1,000 lines down.
|
||||
let text = format!("1{}{}x", "\n".repeat(999), ",".repeat(16_000));
|
||||
let err = s.execute("data.fromTextCsv", json!({"text": text})).expect_err("too many cells");
|
||||
assert!(err.to_string().contains("too large"), "{err}");
|
||||
assert_eq!(s.doc().unwrap().wb.sheets.len(), sheets);
|
||||
// Small imports still work.
|
||||
let out = s.execute("data.getData", json!({"text": r#"[{"a": 1}, {"b": 2}]"#})).unwrap();
|
||||
assert_eq!((out["rows"].as_u64(), out["cols"].as_u64()), (Some(3), Some(2)), "{out}");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -36,28 +36,13 @@ fn max_periods(history: usize) -> u32 {
|
||||
u32::try_from(MAX_WORK / h).unwrap_or(u32::MAX).clamp(1, MAX_PERIODS)
|
||||
}
|
||||
|
||||
/// Most forecast rows when the model is fit to the first `fit` of `history` rows, which span
|
||||
/// `slots` timeline slots once their gaps are filled. With a Forecast Start inside the history,
|
||||
/// every row after it is forecast too (a hindcast row holds the same ETS formulas, each refitting
|
||||
/// the model over the `slots` slots), so those rows (counted from the raw rows) count against
|
||||
/// [`MAX_WORK`] before any forecast row does. `None` when the hindcast alone exceeds it.
|
||||
fn max_periods_from(history: usize, fit: usize, slots: usize) -> Option<u32> {
|
||||
if fit >= history {
|
||||
return Some(max_periods(history));
|
||||
}
|
||||
let f = u64::try_from(slots.max(fit)).unwrap_or(u64::MAX).max(1);
|
||||
let hindcast = u64::try_from(history - fit).unwrap_or(u64::MAX);
|
||||
let rest = (MAX_WORK / f).checked_sub(hindcast).filter(|r| *r >= 1)?;
|
||||
Some(u32::try_from(rest).unwrap_or(u32::MAX).min(MAX_PERIODS))
|
||||
}
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
vec![cmd!(
|
||||
"data.forecastSheet",
|
||||
"Forecast Sheet",
|
||||
["Data", "Forecast"],
|
||||
None,
|
||||
"{timeline?: \"A2:A25\", values?: \"B2:B25\" (default: the first two columns of `range`, the selection or the current region; a text first cell is the header), end?: timeline value or date text | periods?: n (default: a third of the history, at least 1; ≤10,000 and history × periods ≤ 500,000, or with a forecastStart inside the history (hindcast rows are forecast too) (the greater of the fitted rows and fitted slots × (periods + rows from forecastStart on, that row included)) ≤ 500,000; history ≤ 10,000 rows), forecastStart?: a timeline value or date text on the history, before its last point (hindcast: the model is fit to the points before it, the forecast columns start there and run over the actuals; default and the last point: forecast after the history), confidenceInterval?: bool (default true), confidence?: 0.95 or 95, seasonality?: \"auto\" | 0 (none) | 2–8,760, fillMissing?: interpolate|zeros, aggregate?: average|count|counta|max|median|min|sum, statistics?: bool, chart?: line|column} → {sheet, table, chart, history, periods}. Inserts a sheet before the active one: timeline, values, Forecast (FORECAST.ETS), Lower/Upper Confidence Bound (FORECAST.ETS.CONFINT), optional FORECAST.ETS.STAT table, and a chart.",
|
||||
"{timeline?: \"A2:A25\", values?: \"B2:B25\" (default: the first two columns of `range`, the selection or the current region; a text first cell is the header), end?: timeline value or date text | periods?: n (default: a third of the history, at least 1; ≤10,000 and history × periods ≤ 500,000; history ≤ 10,000 rows), forecastStart?: a timeline value or date text on the history, before its last point (hindcast: the model is fit to the points before it, the forecast columns start there and run over the actuals; default and the last point: forecast after the history), confidenceInterval?: bool (default true), confidence?: 0.95 or 95, seasonality?: \"auto\" | 0 (none) | 2–8,760, fillMissing?: interpolate|zeros, aggregate?: average|count|counta|max|median|min|sum, statistics?: bool, chart?: line|column} → {sheet, table, chart, history, periods}. Inserts a sheet before the active one: timeline, values, Forecast (FORECAST.ETS), Lower/Upper Confidence Bound (FORECAST.ETS.CONFINT), optional FORECAST.ETS.STAT table, and a chart.",
|
||||
has_doc,
|
||||
forecast_sheet
|
||||
)]
|
||||
@@ -272,23 +257,13 @@ fn forecast_sheet(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
}
|
||||
}
|
||||
};
|
||||
// The slots the model is fit over: the fit rows' span of the timeline, gaps included.
|
||||
let slots = match (fit < rows.len(), times.get(fit.wrapping_sub(1)), times.first()) {
|
||||
(true, Some(last_fit), Some(first)) => match (timeline.steps_after_last(*last_fit), timeline.steps_after_last(*first)) {
|
||||
(Some(b), Some(a)) => ((b - a).round() + 1.0).clamp(0.0, 1e9) as usize,
|
||||
_ => fit,
|
||||
},
|
||||
_ => fit,
|
||||
};
|
||||
let cap = max_periods_from(rows.len(), fit, slots).ok_or_else(|| {
|
||||
EngineError::Other("The forecast start is too early for this much history: choose a later forecast start or less history.".into())
|
||||
})?;
|
||||
let cap = max_periods(rows.len());
|
||||
let periods = match end {
|
||||
Some(end) => steps_to(&timeline, end, cap)?,
|
||||
None => match number(p, "periods")? {
|
||||
Some(n) if n >= 1.0 && n.ceil() <= f64::from(cap) => n.ceil() as u32,
|
||||
Some(_) => return Err(bad(CMD, format!("`periods` is from 1 to {cap} for {} rows of history", rows.len()))),
|
||||
None => default_periods(rows.len()).min(cap),
|
||||
None => default_periods(rows.len()),
|
||||
},
|
||||
};
|
||||
let future: Vec<f64> =
|
||||
@@ -557,51 +532,6 @@ mod tests {
|
||||
assert_eq!(s.doc().unwrap().wb.sheets.len(), sheets - 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hindcast_rows_count_against_the_work_limit() {
|
||||
use super::{MAX_WORK, max_periods, max_periods_from};
|
||||
assert_eq!(max_periods_from(1_300, 1_300, 1_300), Some(max_periods(1_300)));
|
||||
// 2,000 rows fit to the first 1,899: 101 hindcast rows, then 162 forecast rows.
|
||||
assert_eq!(max_periods_from(2_000, 1_899, 1_899), Some(162));
|
||||
// Fit to the first 1,000: the 1,000 hindcast rows alone are twice the limit.
|
||||
assert_eq!(max_periods_from(2_000, 1_000, 1_000), None);
|
||||
// 800 rows fit to the first 400, which span 571 slots (gaps filled): each formula refits
|
||||
// 571 slots, so 475 forecast rows after the 400 hindcast rows, not 850.
|
||||
assert_eq!(max_periods_from(800, 400, 571), Some(475));
|
||||
assert!((475 + 400) * 571 <= MAX_WORK as usize);
|
||||
for (h, f) in [(2_000usize, 1_899usize), (10_000, 9_990), (100, 2), (60, 50)] {
|
||||
if let Some(p) = max_periods_from(h, f, f) {
|
||||
assert!((u64::from(p) + (h - f) as u64) * f as u64 <= MAX_WORK, "{h} {f}");
|
||||
}
|
||||
}
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
let mut rows = vec![json!(["t", "y"])];
|
||||
rows.extend((1..=2_000).map(|t| json!([t, (t % 7) as f64 + t as f64 * 0.5])));
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": rows})).unwrap();
|
||||
let sheets = s.doc().unwrap().wb.sheets.len();
|
||||
let err = s.execute("data.forecastSheet", json!({"range": "A1:B2001", "forecastStart": 1_001})).expect_err("hindcast too long");
|
||||
assert!(err.to_string().contains("forecast start is too early"), "{err}");
|
||||
let err = s.execute("data.forecastSheet", json!({"range": "A1:B2001", "forecastStart": 1_900, "periods": 163})).expect_err("past the cap");
|
||||
assert!(err.to_string().contains("from 1 to 162"), "{err}");
|
||||
assert_eq!(s.doc().unwrap().wb.sheets.len(), sheets);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_hindcast_cap_follows_the_slots_the_fit_spans_not_its_rows() {
|
||||
// 800 rows, 20% of the slots missing: the first 400 rows span 500 slots, so each ETS
|
||||
// formula refits 500 slots and the cap is 1,000 - 400 = 600 (it was 850 by rows).
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
let times: Vec<u32> = (1u32..).filter(|t| !matches!(t % 10, 3 | 6)).take(800).collect();
|
||||
let mut rows = vec![json!(["t", "y"])];
|
||||
rows.extend(times.iter().map(|t| json!([t, (t % 7) as f64 + f64::from(*t) * 0.5])));
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": rows})).unwrap();
|
||||
let start = times[400];
|
||||
let err = s.execute("data.forecastSheet", json!({"range": "A1:B801", "forecastStart": start, "periods": 601})).expect_err("past the cap");
|
||||
assert!(err.to_string().contains("from 1 to 600"), "{err}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn history_and_periods_are_capped() {
|
||||
use super::{MAX_HISTORY, MAX_PERIODS, MAX_WORK, default_periods, max_periods};
|
||||
|
||||
@@ -57,10 +57,6 @@ fn rows_ref(sheet: &str, origin: CellRef, col: u32, rows: &[u32]) -> Option<Stri
|
||||
/// Most category rows a PivotChart plots.
|
||||
const MAX_CHART_ROWS: usize = 10_000;
|
||||
|
||||
/// Most series a PivotChart gets: the chart renderer reads at most 255 series, and each one owns
|
||||
/// reference text as long as its category rows, copied into every linked chart.
|
||||
const MAX_CHART_SERIES: usize = 255;
|
||||
|
||||
/// A PivotChart's series for a report written at `origin`: categories are the innermost row
|
||||
/// items, one series per item column (column items × value fields); totals are left out.
|
||||
pub fn chart_series(sheet: &str, origin: CellRef, out: &Output) -> Vec<Series> {
|
||||
@@ -68,7 +64,6 @@ pub fn chart_series(sheet: &str, origin: CellRef, out: &Output) -> Vec<Series> {
|
||||
let categories = out.label_col.and_then(|c| rows_ref(sheet, origin, c, &rows));
|
||||
out.chart_cols
|
||||
.iter()
|
||||
.take(MAX_CHART_SERIES)
|
||||
.filter_map(|(c, name)| {
|
||||
Some(Series {
|
||||
name: Some(format!("\"{}\"", name.replace('"', "\"\""))),
|
||||
@@ -111,22 +106,3 @@ pub fn clear_output(wb: &mut Workbook, sheet: usize, idx: usize) {
|
||||
p.last_range = None;
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn a_pivot_chart_gets_at_most_the_series_the_renderer_reads() {
|
||||
let out = Output {
|
||||
grid: vec![],
|
||||
row_kinds: vec![],
|
||||
body_offset: 0,
|
||||
width: 1000,
|
||||
chart_rows: vec![1, 2, 3],
|
||||
chart_cols: (1..1000).map(|c| (c, format!("S{c}"))).collect(),
|
||||
label_col: Some(0),
|
||||
};
|
||||
assert_eq!(chart_series("Sheet1", CellRef::new(0, 0), &out).len(), MAX_CHART_SERIES);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
use super::items::{Acc, FieldItems, build_tree, collect_siblings, is_collapsed, item_label};
|
||||
use super::output::{
|
||||
AggMap, CellKind, ColKind, ColSpec, Ctx, Grid, Line, LineKind, Output, RowKind, ValSrc, caption, data_cols_exceed_sheet, flatten_cols,
|
||||
};
|
||||
use super::output::{AggMap, CellKind, ColKind, ColSpec, Ctx, Grid, Line, LineKind, Output, RowKind, ValSrc, data_cols_exceed_sheet, flatten_cols};
|
||||
use super::{
|
||||
CalcSet, CellError, CellRef, HashMap, HashSet, MAX_AXIS_FIELDS, MAX_COLS, MAX_VALUE_FIELDS, PivotDateGroup, PivotField, PivotFilter, PivotFunc,
|
||||
PivotLayout, PivotShowAs, PivotTable, PivotValue, Source, Value, Workbook, read_source,
|
||||
@@ -96,10 +94,6 @@ struct AggregateData {
|
||||
col_leaves: HashSet<Vec<u32>>,
|
||||
}
|
||||
|
||||
/// Most accumulators (groups times value columns) one report may hold: twice what the 5 million
|
||||
/// group limit allowed at one value field.
|
||||
const MAX_ACCUMULATORS: usize = 16_000_000;
|
||||
|
||||
fn aggregate_record(
|
||||
input: &AggregateInput<'_>,
|
||||
data: &mut AggregateData,
|
||||
@@ -158,9 +152,7 @@ fn aggregate_record(
|
||||
if !input.cols.is_empty() && data_cols_exceed_sheet(data.col_leaves.len(), input.pt.grand_totals_rows, input.vals.len()) {
|
||||
return Err("The PivotTable report will not fit on the sheet.".into());
|
||||
}
|
||||
// Each entry holds one accumulator per value field and calculated-field source column, so the
|
||||
// width counts too: a handful of groups over hundreds of fields is large as well.
|
||||
if data.aggs.len() > 5_000_000 || data.aggs.len().saturating_mul(input.vals.len() + input.extra.len()) > MAX_ACCUMULATORS {
|
||||
if data.aggs.len() > 5_000_000 {
|
||||
return Err("The PivotTable report is too large.".into());
|
||||
}
|
||||
Ok(())
|
||||
@@ -267,8 +259,8 @@ fn write_headers(g: &mut Grid, input: HeaderInput<'_>) -> Result<(), String> {
|
||||
let lv = spec.path.len().saturating_sub(1);
|
||||
let label = spec.path.last().and_then(|it| col_items.get(lv).map(|fi| fi.label(*it))).unwrap_or_default();
|
||||
let text = match vi {
|
||||
Some(vi) if k > 1 => caption(&label, &val_name(*vi)),
|
||||
_ => caption(&label, "Total"),
|
||||
Some(vi) if k > 1 => format!("{label} {}", val_name(*vi)),
|
||||
_ => format!("{label} Total"),
|
||||
};
|
||||
g.set(first_level + lv, c, Value::text(text), CellKind::ColLabel, 0, None);
|
||||
}
|
||||
@@ -326,7 +318,6 @@ struct ShowContext<'a> {
|
||||
value_index: usize,
|
||||
level0: &'a [u32],
|
||||
siblings: &'a HashMap<Vec<u32>, Vec<u32>>,
|
||||
cache: &'a ShowCache,
|
||||
}
|
||||
|
||||
fn number(value: &Option<Value>) -> Option<f64> {
|
||||
@@ -343,67 +334,42 @@ fn ratio(a: Value, b: Option<Value>) -> Value {
|
||||
}
|
||||
}
|
||||
|
||||
/// What Running Total and Rank need from other cells, computed once per sibling set instead of
|
||||
/// once per displayed value (which rescanned the whole set every time).
|
||||
type ShowKey = (Vec<u32>, Vec<u32>, usize);
|
||||
/// Cumulative values by top-level item, and the total of all of them.
|
||||
type RunningTotals = (HashMap<u32, f64>, f64);
|
||||
|
||||
#[derive(Default)]
|
||||
struct ShowCache {
|
||||
/// Ranked values' sibling numbers, sorted ascending without repeats, by (parent, column, value).
|
||||
ranks: std::cell::RefCell<HashMap<ShowKey, Vec<f64>>>,
|
||||
/// Running totals by top-level item, with the total of all of them, by (rest of path, column, value).
|
||||
running: std::cell::RefCell<HashMap<ShowKey, RunningTotals>>,
|
||||
}
|
||||
|
||||
fn running_total(raw: Value, lookup: &ValueLookup<'_>, context: &ShowContext<'_>) -> Value {
|
||||
let Some((first, rest)) = context.row_path.split_first() else { return raw };
|
||||
let Some((first, _)) = context.row_path.split_first() else { return raw };
|
||||
if !matches!(raw, Value::Number(_)) {
|
||||
return raw;
|
||||
}
|
||||
let mut cache = context.cache.running.borrow_mut();
|
||||
let (by_item, all) = cache.entry((rest.to_vec(), context.col_path.to_vec(), context.value_index)).or_insert_with(|| {
|
||||
let mut total = 0.0;
|
||||
let mut by_item = HashMap::new();
|
||||
for item in context.level0 {
|
||||
let mut path = Vec::with_capacity(rest.len() + 1);
|
||||
path.push(*item);
|
||||
path.extend_from_slice(rest);
|
||||
// An item with no number here adds nothing and is not stored (the shown cell always has one).
|
||||
let Some(value) = number(&lookup.get(&path, context.col_path, context.value_index)) else { continue };
|
||||
total += value;
|
||||
by_item.entry(*item).or_insert(total);
|
||||
let mut total = 0.0;
|
||||
for item in context.level0 {
|
||||
let mut path = context.row_path.to_vec();
|
||||
if let Some(first_item) = path.first_mut() {
|
||||
*first_item = *item;
|
||||
}
|
||||
(by_item, total)
|
||||
});
|
||||
Value::number(by_item.get(first).copied().unwrap_or(*all))
|
||||
total += number(&lookup.get(&path, context.col_path, context.value_index)).unwrap_or(0.0);
|
||||
if item == first {
|
||||
break;
|
||||
}
|
||||
}
|
||||
Value::number(total)
|
||||
}
|
||||
|
||||
fn ranked_value(raw: Value, lookup: &ValueLookup<'_>, context: &ShowContext<'_>) -> Value {
|
||||
let Some((_, parent)) = context.row_path.split_last() else { return Value::Empty };
|
||||
let Some(me) = raw.as_f64() else { return raw };
|
||||
let mut cache = context.cache.ranks.borrow_mut();
|
||||
let sorted = cache.entry((parent.to_vec(), context.col_path.to_vec(), context.value_index)).or_insert_with(|| {
|
||||
let mut all: Vec<f64> = context
|
||||
.siblings
|
||||
.get(parent)
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.filter_map(|sibling| {
|
||||
let mut path = parent.to_vec();
|
||||
path.push(*sibling);
|
||||
number(&lookup.get(&path, context.col_path, context.value_index))
|
||||
})
|
||||
.collect();
|
||||
all.sort_by(f64::total_cmp);
|
||||
all.dedup();
|
||||
all
|
||||
});
|
||||
let siblings = context.siblings.get(parent).cloned().unwrap_or_default();
|
||||
// Excel's ranks are dense: ties share a rank and the next value takes the next one
|
||||
// (5, 4, 3, 3, 4 rank 1, 2, 3, 3, 2), so count the distinct larger values.
|
||||
let larger = sorted.len() - sorted.partition_point(|value| *value <= me);
|
||||
Value::number(larger as f64 + 1.0)
|
||||
let mut larger: Vec<f64> = siblings
|
||||
.into_iter()
|
||||
.filter_map(|sibling| {
|
||||
let mut path = parent.to_vec();
|
||||
path.push(sibling);
|
||||
number(&lookup.get(&path, context.col_path, context.value_index)).filter(|value| *value > me)
|
||||
})
|
||||
.collect();
|
||||
larger.sort_by(f64::total_cmp);
|
||||
larger.dedup();
|
||||
Value::number(larger.len() as f64 + 1.0)
|
||||
}
|
||||
|
||||
fn show_value(definition: &PivotValue, raw: Value, lookup: &ValueLookup<'_>, context: &ShowContext<'_>) -> Value {
|
||||
@@ -676,7 +642,6 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
})
|
||||
.collect();
|
||||
let lookup = ValueLookup { wb, source: src, calc: &calc, vals: &vals, extra: &extra, aggs: &aggs, value_count: k };
|
||||
let show_cache = ShowCache::default();
|
||||
let mut chart_rows: Vec<u32> = Vec::new();
|
||||
let chart_cols: Vec<(u32, String)> = data_cols
|
||||
.iter()
|
||||
@@ -734,7 +699,7 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
let Some((_, vdef)) = vals.get(*vi) else { continue };
|
||||
let cp = spec.path.as_slice();
|
||||
let Some(raw) = lookup.get(rp, cp, *vi) else { continue };
|
||||
let context = ShowContext { row_path: rp, col_path: cp, value_index: *vi, level0: &level0, siblings: &siblings, cache: &show_cache };
|
||||
let context = ShowContext { row_path: rp, col_path: cp, value_index: *vi, level0: &level0, siblings: &siblings };
|
||||
let shown = show_value(vdef, raw, &lookup, &context);
|
||||
if let Some(pr) = probe.as_deref_mut() {
|
||||
if pr.at == Some((r, l + j)) {
|
||||
|
||||
@@ -121,18 +121,6 @@ pub(super) enum ColKind {
|
||||
Grand,
|
||||
}
|
||||
|
||||
/// Longest item caption Excel keeps; a subtotal caption repeats its parent's label for every value
|
||||
/// field at every level, so a long source label is cut rather than multiplied.
|
||||
const MAX_CAPTION_LABEL_CHARS: usize = 255;
|
||||
|
||||
/// `label` (cut to [`MAX_CAPTION_LABEL_CHARS`]) and `suffix`, as in "East Total".
|
||||
pub(super) fn caption(label: &str, suffix: &str) -> String {
|
||||
let mut out: String = label.chars().take(MAX_CAPTION_LABEL_CHARS).collect();
|
||||
out.push(' ');
|
||||
out.push_str(suffix);
|
||||
out
|
||||
}
|
||||
|
||||
pub(super) struct ColSpec {
|
||||
pub(super) kind: ColKind,
|
||||
pub(super) path: Vec<u32>,
|
||||
@@ -174,7 +162,7 @@ impl Ctx<'_> {
|
||||
leaf: false,
|
||||
path: prefix.to_vec(),
|
||||
values: true,
|
||||
labels: vec![(col, Value::text(caption(label, name)), indent, None)],
|
||||
labels: vec![(col, Value::text(format!("{label} {name}")), indent, None)],
|
||||
vi: Some(vi),
|
||||
});
|
||||
}
|
||||
@@ -261,7 +249,7 @@ impl Ctx<'_> {
|
||||
leaf: false,
|
||||
path: prefix.clone(),
|
||||
values: true,
|
||||
labels: vec![(col, Value::text(caption(&label, "Total")), indent, None)],
|
||||
labels: vec![(col, Value::text(format!("{label} Total")), indent, None)],
|
||||
vi,
|
||||
});
|
||||
}
|
||||
@@ -328,7 +316,7 @@ impl Ctx<'_> {
|
||||
leaf: false,
|
||||
path: prefix.clone(),
|
||||
values: true,
|
||||
labels: vec![(col, Value::text(caption(&label, "Total")), 0, None)],
|
||||
labels: vec![(col, Value::text(format!("{label} Total")), 0, None)],
|
||||
vi,
|
||||
});
|
||||
}
|
||||
@@ -450,17 +438,3 @@ pub(super) fn cell_style(lk: &Look, rk: RowKind, cell: &OutCell, last_header: bo
|
||||
}
|
||||
s
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn captions_cut_a_long_parent_label() {
|
||||
assert_eq!(caption("East", "Total"), "East Total");
|
||||
let long = "é".repeat(100_000);
|
||||
let c = caption(&long, "Sum of Sales");
|
||||
assert_eq!(c.chars().count(), MAX_CAPTION_LABEL_CHARS + " Sum of Sales".len());
|
||||
assert!(c.ends_with(" Sum of Sales"));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1350,18 +1350,6 @@ fn scripts_leave_file_access_working_after_they_run() {
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn get_data_refuses_json_with_too_many_fields_or_rows_before_building_rows() {
|
||||
let mut s = s();
|
||||
let wide = format!("[{}]", (0..=gridcraft_core::MAX_COLS).map(|i| format!("{{\"k{i}\":1}}")).collect::<Vec<_>>().join(","));
|
||||
let err = s.execute("data.fromTextCsv", json!({"text": wide})).unwrap_err().to_string();
|
||||
assert!(err.contains("more fields"), "{err}");
|
||||
// MAX_ROWS objects plus the header row are one too many.
|
||||
let tall = format!("[{}]", vec!["{}"; gridcraft_core::MAX_ROWS as usize].join(","));
|
||||
let err = s.execute("data.fromTextCsv", json!({"text": tall})).unwrap_err().to_string();
|
||||
assert!(err.contains("more rows"), "{err}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scripts_cannot_reach_outside_the_workbook_even_when_trusted() {
|
||||
let dir = std::env::temp_dir().join(format!("gridcraft-script-deny-{}", std::process::id()));
|
||||
|
||||
@@ -70,43 +70,27 @@ fn cell_criterion(v: &Value) -> Option<Criterion> {
|
||||
/// when the label is unknown, criterion).
|
||||
type CriteriaRow = (usize, Vec<(usize, Option<usize>, Criterion)>);
|
||||
|
||||
/// Most condition tests one selection may make (records times conditions): every record can be
|
||||
/// tested against every criteria row when none matches, so a modest database and criteria table
|
||||
/// multiply into billions of tests. Past it the function is `#NUM!`, as lifted lookups are; 5e8
|
||||
/// is a few seconds of matching.
|
||||
const SELECTION_WORK_BUDGET: usize = 500_000_000;
|
||||
|
||||
/// Rows (1-based within the database, excluding the header) of matching records.
|
||||
fn matching_records(db: &Array, crit: &Array, ctx: &mut dyn Ctx) -> R<Vec<usize>> {
|
||||
// The database column under each criteria label, found once per label rather than per cell.
|
||||
let columns: Vec<Option<usize>> = (0..crit.cols)
|
||||
.map(|c| match crit.get(0, c) {
|
||||
Some(Value::Text(t)) => find_column(db, t),
|
||||
Some(Value::Number(n)) => find_column(db, &gridcraft_core::number_to_text(*n)),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
fn matching_records(db: &Array, crit: &Array, ctx: &mut dyn Ctx) -> Vec<usize> {
|
||||
// Per criteria row: its index and a list of (criteria column, database column or None when
|
||||
// the label is unknown, criterion).
|
||||
let mut rows: Vec<CriteriaRow> = Vec::new();
|
||||
let mut tests = 0usize;
|
||||
for r in 1..crit.rows {
|
||||
let mut conds = Vec::new();
|
||||
for c in 0..crit.cols {
|
||||
let Some(cell) = crit.get(r, c) else { continue };
|
||||
let Some(cr) = cell_criterion(cell) else { continue };
|
||||
conds.push((c, columns.get(c).copied().flatten(), cr));
|
||||
let col = match crit.get(0, c) {
|
||||
Some(Value::Text(t)) => find_column(db, t),
|
||||
Some(Value::Number(n)) => find_column(db, &gridcraft_core::number_to_text(*n)),
|
||||
_ => None,
|
||||
};
|
||||
conds.push((c, col, cr));
|
||||
}
|
||||
tests = tests.saturating_add(conds.len().max(1));
|
||||
rows.push((r, conds));
|
||||
}
|
||||
// An empty criteria row matches every record without testing a condition, so nothing is charged.
|
||||
let all_match = rows.is_empty() || rows.iter().any(|(_, conds)| conds.is_empty());
|
||||
// Computed criteria (a formula evaluated per record) count like any other test.
|
||||
if !all_match && db.rows.saturating_sub(1).saturating_mul(tests) > SELECTION_WORK_BUDGET {
|
||||
return Err(CellError::Num);
|
||||
}
|
||||
Ok((1..db.rows)
|
||||
let all_match = rows.is_empty();
|
||||
(1..db.rows)
|
||||
.filter(|&rec| {
|
||||
all_match
|
||||
|| rows.iter().any(|(r, conds)| {
|
||||
@@ -118,7 +102,7 @@ fn matching_records(db: &Array, crit: &Array, ctx: &mut dyn Ctx) -> R<Vec<usize>
|
||||
})
|
||||
})
|
||||
})
|
||||
.collect())
|
||||
.collect()
|
||||
}
|
||||
|
||||
struct Selection<'a> {
|
||||
@@ -139,7 +123,7 @@ fn select<'a>(a: &'a [Arg], ctx: &mut dyn Ctx) -> R<Selection<'a>> {
|
||||
let db = as_array(dbv);
|
||||
let crit = as_array(critv);
|
||||
let field = field_index(&db, a)?;
|
||||
let records = matching_records(&db, &crit, ctx)?;
|
||||
let records = matching_records(&db, &crit, ctx);
|
||||
Ok(Selection { db, field, records })
|
||||
}
|
||||
|
||||
@@ -368,27 +352,6 @@ mod tests {
|
||||
is_err(d("DSUM", n(9.0)), CellError::Value);
|
||||
}
|
||||
|
||||
/// Security: records times criteria conditions past the selection budget is `#NUM!` before
|
||||
/// any record is tested; a nonmatching criteria table used to test every record against
|
||||
/// every criteria row.
|
||||
#[test]
|
||||
fn selection_work_is_bounded() {
|
||||
use gridcraft_core::Array;
|
||||
let column = |label: &str, len: usize, v: Value| {
|
||||
let mut data = vec![tv(label)];
|
||||
data.extend(std::iter::repeat_n(v, len));
|
||||
Value::from(Array::column(data))
|
||||
};
|
||||
let db = column("Tree", 100_000, tv("Apple"));
|
||||
let wide = column("Tree", 5_001, tv("=Plum"));
|
||||
is_err(ev("DCOUNTA", vec![rf(db.clone()), t("Tree"), rf(wide)]), CellError::Num);
|
||||
let narrow = column("Tree", 2, tv("=Apple"));
|
||||
close(ev("DCOUNTA", vec![rf(db.clone()), t("Tree"), rf(narrow)]), 100_000.0);
|
||||
// Empty criteria rows test no condition: the first one matches every record, so they cost nothing.
|
||||
let empty_rows = column("Tree", 5_001, Value::Empty);
|
||||
close(ev("DCOUNTA", vec![rf(db), t("Tree"), rf(empty_rows)]), 100_000.0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simple_criteria() {
|
||||
let c = |cells: Vec<Value>| arr(vec![vec![tv("Tree"), tv("Height")], cells]);
|
||||
|
||||
@@ -416,17 +416,13 @@ fn workday_core(a: &[Arg], c: &mut dyn Ctx, mask: [bool; 7], hol: Option<&Arg>)
|
||||
if days == 0 {
|
||||
return num_val(start as f64);
|
||||
}
|
||||
// The holidays on working days, still sorted (`holidays` sorts them), so each step counts
|
||||
// the ones it passed with two binary searches rather than a scan of every holiday: a run of
|
||||
// consecutive holidays takes one step per holiday.
|
||||
let hs: Vec<i64> = hs.into_iter().filter(|&h| !mask[weekday0(sys, h)]).collect();
|
||||
let dir = days.signum();
|
||||
let mut cur = start;
|
||||
let mut rem = days.abs();
|
||||
while rem > 0 {
|
||||
let next = advance(sys, cur, rem, dir, &mask, per_week);
|
||||
let (lo, hi) = if dir > 0 { (cur + 1, next) } else { (next, cur - 1) };
|
||||
rem = hs.partition_point(|&h| h <= hi).saturating_sub(hs.partition_point(|&h| h < lo)) as i64;
|
||||
rem = hs.iter().filter(|&&h| h >= lo && h <= hi && !mask[weekday0(sys, h)]).count() as i64;
|
||||
cur = next;
|
||||
if !(0..=MAX_SERIAL as i64).contains(&cur) {
|
||||
return Err(CellError::Num);
|
||||
@@ -759,23 +755,6 @@ mod tests {
|
||||
is_err(ev("TIMEVALUE", vec![t("x")]), CellError::Value);
|
||||
}
|
||||
|
||||
/// Security: WORKDAY counts the holidays each step passes by binary search, so a long run of
|
||||
/// consecutive holidays is linear work, not one scan of every holiday per holiday.
|
||||
#[test]
|
||||
fn workday_over_many_consecutive_holidays() {
|
||||
let start = d(2000.0, 1.0, 3.0);
|
||||
let hol: Vec<f64> = (1..=200_000).map(|i| start + f64::from(i)).collect();
|
||||
let out = ev("WORKDAY.INTL", vec![n(start), n(1.0), n(11.0), av(col(&hol))]);
|
||||
// Sundays are the only weekend (11): 200,000 days of holidays are skipped, landing on the
|
||||
// first working day after them.
|
||||
let after = start + 200_001.0;
|
||||
let sunday = ev("WEEKDAY", vec![n(after), n(2.0)]) == nv(7.0);
|
||||
close(out, if sunday { after + 1.0 } else { after });
|
||||
// Holidays on a weekend don't push the result out.
|
||||
let fri = d(2026.0, 10.0, 9.0);
|
||||
close(ev("WORKDAY", vec![n(fri), n(1.0), av(col(&[fri + 1.0, fri + 3.0]))]), fri + 4.0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn day_counts() {
|
||||
close(ev("DAYS", vec![n(d(2021.0, 3.0, 15.0)), n(d(2021.0, 2.0, 1.0))]), 42.0);
|
||||
|
||||
@@ -171,17 +171,13 @@ fn sort(args: &[Arg], _c: &mut dyn Ctx) -> R<Value> {
|
||||
let a = if by_col { a.transpose() } else { a };
|
||||
let idx = if has(args, 1) { int_list(&arg(args, 1)?.value)? } else { vec![1] };
|
||||
let ord = if has(args, 2) { int_list(&arg(args, 2)?.value)? } else { vec![1] };
|
||||
if idx.is_empty() || idx.iter().any(|&i| i < 1 || i > a.cols as i64) || ord.iter().any(|&o| o != 1 && o != -1) {
|
||||
if idx.is_empty() || idx.iter().any(|&i| i < 1 || i as usize > a.cols) || ord.iter().any(|&o| o != 1 && o != -1) {
|
||||
return Err(CellError::Value);
|
||||
}
|
||||
if ord.len() > 1 && ord.len() != idx.len() {
|
||||
return Err(CellError::Value);
|
||||
}
|
||||
let orders: Vec<i64> = (0..idx.len()).map(|i| *ord.get(i).or(ord.first()).unwrap_or(&1)).collect();
|
||||
// A column repeated in sort_index can't break a tie its first use left, so only first uses
|
||||
// stay: the keys copied per row are then at most the row itself, however long sort_index is.
|
||||
let mut seen = std::collections::HashSet::new();
|
||||
let (idx, orders): (Vec<i64>, Vec<i64>) = idx.into_iter().zip(orders).filter(|(i, _)| seen.insert(*i)).unzip();
|
||||
let mut lines: Vec<(Vec<Value>, Vec<Value>)> =
|
||||
rows_of(&a).into_iter().map(|r| (idx.iter().map(|&i| r.get(i as usize - 1).cloned().unwrap_or(Value::Empty)).collect(), r)).collect();
|
||||
lines.sort_by(|x, y| cmp_keys(&x.0, &y.0, &orders));
|
||||
@@ -932,16 +928,9 @@ fn pivotby(args: &[Arg], ctx: &mut dyn Ctx) -> R<Value> {
|
||||
let ckeys: Vec<Vec<Value>> = p.rows.iter().map(|&r| key_row(&cf, r)).collect();
|
||||
let rk = distinct_keys(&rkeys, if row_sort.unsigned_abs() as usize <= rf.cols { row_sort } else { 0 });
|
||||
let ck = distinct_keys(&ckeys, if col_sort.unsigned_abs() as usize <= cf.cols { col_sort } else { 0 });
|
||||
// Source rows of every row key, column key and pair, built in one pass, so a total reads
|
||||
// its rows instead of rescanning the whole source once per total.
|
||||
let mut cell: HashMap<(String, String), Vec<usize>> = HashMap::new();
|
||||
let mut by_row: HashMap<String, Vec<usize>> = HashMap::new();
|
||||
let mut by_col: HashMap<String, Vec<usize>> = HashMap::new();
|
||||
for ((r, c), &i) in rkeys.iter().zip(ckeys.iter()).zip(p.rows.iter()) {
|
||||
let (r, c) = (row_key(r), row_key(c));
|
||||
by_row.entry(r.clone()).or_default().push(i);
|
||||
by_col.entry(c.clone()).or_default().push(i);
|
||||
cell.entry((r, c)).or_default().push(i);
|
||||
cell.entry((row_key(r), row_key(c))).or_default().push(i);
|
||||
}
|
||||
let mut agg = |rows: &[usize], c: usize| -> Value {
|
||||
if rows.is_empty() {
|
||||
@@ -951,12 +940,14 @@ fn pivotby(args: &[Arg], ctx: &mut dyn Ctx) -> R<Value> {
|
||||
aggregate_with(f, &vs, ctx)
|
||||
};
|
||||
let rows_for = |r: Option<&Vec<Value>>, c: Option<&Vec<Value>>| -> Vec<usize> {
|
||||
match (r, c) {
|
||||
(Some(r), Some(c)) => cell.get(&(row_key(r), row_key(c))).cloned().unwrap_or_default(),
|
||||
(Some(r), None) => by_row.get(&row_key(r)).cloned().unwrap_or_default(),
|
||||
(None, Some(c)) => by_col.get(&row_key(c)).cloned().unwrap_or_default(),
|
||||
(None, None) => p.rows.clone(),
|
||||
}
|
||||
let rkey = r.map(|k| row_key(k));
|
||||
let ckey = c.map(|k| row_key(k));
|
||||
p.rows
|
||||
.iter()
|
||||
.zip(rkeys.iter().zip(ckeys.iter()))
|
||||
.filter(|(_, (a, b))| rkey.as_ref().is_none_or(|k| *k == row_key(a)) && ckey.as_ref().is_none_or(|k| *k == row_key(b)))
|
||||
.map(|(&i, _)| i)
|
||||
.collect()
|
||||
};
|
||||
let mut cols: Vec<Option<&Vec<Value>>> = ck.iter().map(Some).collect();
|
||||
if col_total > 0 {
|
||||
@@ -1006,7 +997,10 @@ fn pivotby(args: &[Arg], ctx: &mut dyn Ctx) -> R<Value> {
|
||||
}
|
||||
};
|
||||
for c in &cols {
|
||||
let rows = rows_for(r, *c);
|
||||
let rows = match (r, c) {
|
||||
(Some(rk), Some(ck)) => cell.get(&(row_key(rk), row_key(ck))).cloned().unwrap_or_default(),
|
||||
_ => rows_for(r, *c),
|
||||
};
|
||||
for vc in 0..vals.cols {
|
||||
line.push(agg(&rows, vc));
|
||||
}
|
||||
@@ -1210,21 +1204,6 @@ mod tests {
|
||||
assert_eq!(rows_of(&r), vec![vec![nv(0.0), nv(5.0)], vec![nv(1.0), nv(2.0)], vec![nv(1.0), nv(1.0)]]);
|
||||
}
|
||||
|
||||
/// Security: a column repeated in sort_index keys the sort once. The keys copied per row stay
|
||||
/// within the row, however long sort_index is, and a repeat (even with the other order) can't
|
||||
/// change the result, since its first use already ordered the rows.
|
||||
#[test]
|
||||
fn sort_drops_repeated_sort_indices() {
|
||||
let m = || av(arr(vec![vec![nv(1.0), nv(2.0)], vec![nv(1.0), nv(1.0)], vec![nv(0.0), nv(5.0)]]));
|
||||
let want = vec![vec![nv(0.0), nv(5.0)], vec![nv(1.0), nv(2.0)], vec![nv(1.0), nv(1.0)]];
|
||||
let r = ev("SORT", vec![m(), av(row(&[1.0, 1.0, 2.0, 1.0])), av(row(&[1.0, -1.0, -1.0, 1.0]))]);
|
||||
assert_eq!(rows_of(&r), want);
|
||||
let idx = vec![1.0; 1_000_000];
|
||||
let tall = av(gridcraft_core::Array::filled(2_000, 1, nv(1.0)).into());
|
||||
let r = ev("SORT", vec![tall, av(row(&idx))]);
|
||||
assert_eq!(rows_of(&r).len(), 2_000);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sortby() {
|
||||
let r = ev("SORTBY", vec![av(col(&[1.0, 2.0, 3.0])), av(col(&[30.0, 10.0, 20.0]))]);
|
||||
@@ -1468,16 +1447,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
/// Security: PIVOTBY totals read their source rows from indexes built in the grouping pass,
|
||||
/// rather than rescanning the source once per total, so many distinct keys stay linear.
|
||||
#[test]
|
||||
fn pivotby_totals_with_many_groups() {
|
||||
let keys: Vec<f64> = (0..20_000).map(f64::from).collect();
|
||||
let r = rows_of(&ev("PIVOTBY", vec![av(col(&keys)), av(col(&vec![1.0; 20_000])), av(col(&vec![2.0; 20_000])), t("SUM")]));
|
||||
assert_eq!(r.get(1), Some(&vec![nv(0.0), nv(2.0), nv(2.0)]));
|
||||
assert_eq!(r.last(), Some(&vec![tv("Total"), nv(40_000.0), nv(40_000.0)]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pivotby_size_check_counts_column_header_rows() {
|
||||
// One row, n column fields and n value columns: n header rows + value-name row + body row + total row,
|
||||
|
||||
@@ -13,6 +13,7 @@ mod day_count;
|
||||
mod depreciation;
|
||||
mod securities;
|
||||
mod tvm;
|
||||
pub(crate) use tvm::cumulative_args;
|
||||
|
||||
use day_count::{coupdaybs, coupdays, coupdaysnc, coupncd, coupnum, couppcd};
|
||||
use depreciation::{amordegrc, amorlinc, db, ddb, sln, syd, vdb};
|
||||
|
||||
@@ -116,7 +116,9 @@ pub(super) fn ppmt(a: &[Arg], _c: &mut dyn Ctx) -> R<Value> {
|
||||
num_val(pmt_calc(rate, np, pv, fv, typ) - ipmt_calc(rate, per, np, pv, fv, typ))
|
||||
}
|
||||
|
||||
fn cumulative(a: &[Arg], principal: bool) -> R<Value> {
|
||||
/// The validated (rate, periods, pv, start, end, type) of CUMIPMT/CUMPRINC: every check that
|
||||
/// refuses a call before its period loop, shared with the lifted-call work preflight.
|
||||
pub(crate) fn cumulative_args(a: &[Arg]) -> R<(f64, f64, f64, f64, f64, f64)> {
|
||||
let (rate, np, pv) = (num(a, 0)?, num(a, 1)?, num(a, 2)?);
|
||||
let (start, end, typ) = (num(a, 3)?.trunc(), num(a, 4)?.trunc(), num(a, 5)?);
|
||||
let np_i = np.trunc();
|
||||
@@ -126,6 +128,11 @@ fn cumulative(a: &[Arg], principal: bool) -> R<Value> {
|
||||
if end - start > 1e7 || np_i > 1e15 {
|
||||
return Err(CellError::Num);
|
||||
}
|
||||
Ok((rate, np_i, pv, start, end, typ))
|
||||
}
|
||||
|
||||
fn cumulative(a: &[Arg], principal: bool) -> R<Value> {
|
||||
let (rate, np_i, pv, start, end, typ) = cumulative_args(a)?;
|
||||
let p = pmt_calc(rate, np_i, pv, 0.0, typ);
|
||||
let mut sum = 0.0;
|
||||
let mut per = start;
|
||||
|
||||
+181
-26
@@ -63,26 +63,78 @@ const SCANS: &[&str] = &["VLOOKUP", "HLOOKUP", "LOOKUP", "MATCH", "XLOOKUP", "XM
|
||||
/// `XMATCH(SEQUENCE(1048576), -SEQUENCE(1048576))` runs for hours and hangs opening the file.
|
||||
/// Past the budget the call is `#NUM!`, as MMULT is past 2e9 multiply-adds. 5e8 keeps the worst
|
||||
/// case to a few seconds and still admits 5,000 needles over a 100,000-row table.
|
||||
///
|
||||
/// The same budget covers all the work of a lifted call added up across its elements: criteria
|
||||
/// aggregates rescanning their ranges, period loops, and array results built per element.
|
||||
const LIFTED_SCAN_BUDGET: usize = 500_000_000;
|
||||
|
||||
/// The length of the longest vector a lifted call of `spec` searches per needle: 0 unless `spec`
|
||||
/// is one of the [`SCANS`] lookups and a non-lifted argument is an array.
|
||||
/// Criteria aggregates: every call tests each cell of its ranges against its criteria, so a call
|
||||
/// lifted over `n` criteria does `n` x (range cells) work, like the [`SCANS`] lookups.
|
||||
const CRITERIA: &[&str] = &["COUNTIF", "COUNTIFS", "SUMIF", "SUMIFS", "AVERAGEIF", "AVERAGEIFS", "MAXIFS", "MINIFS"];
|
||||
|
||||
/// Cumulative TVM functions that step through every period from `start_period` (argument 3) to
|
||||
/// `end_period` (argument 4) on each call.
|
||||
const PERIOD_LOOPS: &[&str] = &["CUMIPMT", "CUMPRINC"];
|
||||
|
||||
/// The work every lifted call of `spec` repeats over its non-lifted arguments: the longest vector
|
||||
/// a [`SCANS`] lookup searches, or every cell a [`CRITERIA`] aggregate tests. 0 for other
|
||||
/// functions.
|
||||
fn scan_len(spec: &FnSpec, args: &[Arg]) -> usize {
|
||||
if !SCANS.contains(&spec.name) {
|
||||
let scans = SCANS.contains(&spec.name);
|
||||
if !scans && !CRITERIA.contains(&spec.name) {
|
||||
return 0;
|
||||
}
|
||||
args.iter()
|
||||
.enumerate()
|
||||
.filter(|(i, _)| !spec.is_scalar_arg(*i))
|
||||
.filter_map(|(_, a)| match &a.value {
|
||||
Value::Array(arr) => Some(arr.rows.max(arr.cols)),
|
||||
_ => None,
|
||||
})
|
||||
.max()
|
||||
.unwrap_or(0)
|
||||
let lens = args.iter().enumerate().filter(|(i, _)| !spec.is_scalar_arg(*i)).filter_map(|(_, a)| match &a.value {
|
||||
Value::Array(arr) => Some(if scans { arr.rows.max(arr.cols) } else { arr.data.len() }),
|
||||
_ => None,
|
||||
});
|
||||
if scans { lens.max().unwrap_or(0) } else { lens.fold(0, usize::saturating_add) }
|
||||
}
|
||||
|
||||
/// The work of one lifted call that depends on its own (lifted) scalar arguments: the number of
|
||||
/// periods a [`PERIOD_LOOPS`] function steps through. 0 for other functions.
|
||||
fn call_cost(spec: &FnSpec, cell_args: &[Arg]) -> usize {
|
||||
if !PERIOD_LOOPS.contains(&spec.name) {
|
||||
return 0;
|
||||
}
|
||||
// Coercing numeric text reads all of it, even in a call the function then refuses, so each
|
||||
// character is charged as well: of the arguments it coerces in order, up to the first that fails.
|
||||
let mut parse = 0usize;
|
||||
for (i, a) in cell_args.iter().enumerate().take(6) {
|
||||
if let Value::Text(t) = &a.value {
|
||||
parse = parse.saturating_add(t.len());
|
||||
}
|
||||
if crate::util::num(cell_args, i).is_err() {
|
||||
break;
|
||||
}
|
||||
}
|
||||
// The function's own validation and coercion (text like "10000000" counts), so a call it
|
||||
// refuses before its loop costs nothing and no loop goes uncharged.
|
||||
let periods = crate::financial::cumulative_args(cell_args).map_or(0, |(.., start, end, _)| (end - start + 1.0) as usize);
|
||||
parse.saturating_add(periods)
|
||||
}
|
||||
|
||||
pub(crate) fn call_lifted(spec: &FnSpec, args: &[Arg], ctx: &mut dyn Ctx) -> Value {
|
||||
call_lifted_within(spec, args, ctx, LIFTED_SCAN_BUDGET)
|
||||
}
|
||||
|
||||
/// Sets the lifted arguments of `cell_args` to their elements at (`r`, `c`).
|
||||
fn element_args(spec: &FnSpec, args: &[Arg], r: usize, c: usize, cell_args: &mut [Arg]) {
|
||||
for (i, a) in args.iter().enumerate() {
|
||||
if spec.is_scalar_arg(i)
|
||||
&& let Value::Array(arr) = &a.value
|
||||
&& let Some(slot) = cell_args.get_mut(i)
|
||||
{
|
||||
let v = arr.get_broadcast(r, c);
|
||||
slot.value = if let Value::Array(inner) = &v { inner.data.first().cloned().unwrap_or(Value::Empty) } else { v };
|
||||
// A blank element of a written array argument is given, as a scalar blank is.
|
||||
slot.blank_value = !slot.from_ref && matches!(slot.value, Value::Empty);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// [`call_lifted`] with every call's work added up against `budget` (see [`LIFTED_SCAN_BUDGET`]).
|
||||
fn call_lifted_within(spec: &FnSpec, args: &[Arg], ctx: &mut dyn Ctx, budget: usize) -> Value {
|
||||
let rejected = if spec.value_args.is_empty() { None } else { reject_multi_cell_refs(spec, args) };
|
||||
let args = rejected.as_deref().unwrap_or(args);
|
||||
let mut rows = 0usize;
|
||||
@@ -101,27 +153,42 @@ pub(crate) fn call_lifted(spec: &FnSpec, args: &[Arg], ctx: &mut dyn Ctx) -> Val
|
||||
return (spec.imp)(args, ctx);
|
||||
}
|
||||
let needles = rows.saturating_mul(cols);
|
||||
if needles > MAX_CELLS || needles.saturating_mul(scan_len(spec, args)) > LIFTED_SCAN_BUDGET {
|
||||
// Every call is charged its repeated scan (at least 1), its own period loop, and the cells of
|
||||
// an array result (built in full, though only its first cell is kept), so lifting a scalar
|
||||
// argument can't multiply what one call may do into hours of work:
|
||||
// `COUNTIF(big_range, SEQUENCE(1e4))`, `CUMIPMT(0.1, 1e7, 1, 1, SEQUENCE(1e4,,1e7,0), 0)`,
|
||||
// `MUNIT(SEQUENCE(1e4,,3000,0))`.
|
||||
let per_call = scan_len(spec, args).max(1);
|
||||
let mut cell_args: Vec<Arg> = args.to_vec();
|
||||
let mut spent = needles.saturating_mul(per_call);
|
||||
if needles > MAX_CELLS || spent > budget {
|
||||
return Value::Error(CellError::Num);
|
||||
}
|
||||
let mut cell_args: Vec<Arg> = args.to_vec();
|
||||
// Period loops are known before any call runs, so a call over budget does none of them.
|
||||
if PERIOD_LOOPS.contains(&spec.name) {
|
||||
for r in 0..rows {
|
||||
for c in 0..cols {
|
||||
element_args(spec, args, r, c, &mut cell_args);
|
||||
spent = spent.saturating_add(call_cost(spec, &cell_args));
|
||||
if spent > budget {
|
||||
return Value::Error(CellError::Num);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut data = Vec::with_capacity(rows * cols);
|
||||
for r in 0..rows {
|
||||
for c in 0..cols {
|
||||
for (i, a) in args.iter().enumerate() {
|
||||
if spec.is_scalar_arg(i)
|
||||
&& let Value::Array(arr) = &a.value
|
||||
&& let Some(slot) = cell_args.get_mut(i)
|
||||
{
|
||||
let v = arr.get_broadcast(r, c);
|
||||
slot.value = if let Value::Array(inner) = &v { inner.data.first().cloned().unwrap_or(Value::Empty) } else { v };
|
||||
// A blank element of a written array argument is given, as a scalar blank is.
|
||||
slot.blank_value = !slot.from_ref && matches!(slot.value, Value::Empty);
|
||||
}
|
||||
}
|
||||
element_args(spec, args, r, c, &mut cell_args);
|
||||
let out = (spec.imp)(&cell_args, ctx);
|
||||
data.push(match out {
|
||||
Value::Array(a) => a.data.first().cloned().unwrap_or(Value::Empty),
|
||||
Value::Array(a) => {
|
||||
spent = spent.saturating_add(a.data.len());
|
||||
if spent > budget {
|
||||
return Value::Error(CellError::Num);
|
||||
}
|
||||
a.data.first().cloned().unwrap_or(Value::Empty)
|
||||
}
|
||||
v => v,
|
||||
});
|
||||
}
|
||||
@@ -206,6 +273,94 @@ mod tests {
|
||||
assert_eq!(rows_of(&out), vec![vec![nv(-1.0)]; 1000]);
|
||||
}
|
||||
|
||||
/// Security: lifting a criteria aggregate rescans its range for every criterion, so criteria
|
||||
/// x range cells past the budget is `#NUM!` before any scan runs.
|
||||
#[test]
|
||||
fn lifted_criteria_aggregates_stop_past_their_work_budget() {
|
||||
use gridcraft_core::Array;
|
||||
let tall = |n: usize| av(Array::filled(n, 1, nv(-1.0)).into());
|
||||
is_err(ev("COUNTIF", vec![tall(1_000_000), tall(501)]), CellError::Num);
|
||||
is_err(ev("SUMIF", vec![tall(1_000_000), tall(501)]), CellError::Num);
|
||||
is_err(ev("COUNTIFS", vec![tall(1_000_000), tall(501)]), CellError::Num);
|
||||
// Two ranges of 250,000 cells each count together.
|
||||
is_err(ev("SUMIFS", vec![tall(250_000), tall(250_000), tall(1001)]), CellError::Num);
|
||||
let counts = ev("COUNTIF", vec![av(col(&[1.0, 2.0, 2.0])), av(col(&[2.0, 1.0, 5.0]))]);
|
||||
assert_eq!(rows_of(&counts), vec![vec![nv(2.0)], vec![nv(1.0)], vec![nv(0.0)]]);
|
||||
for name in super::CRITERIA.iter().chain(super::PERIOD_LOOPS) {
|
||||
assert!(crate::lookup(name).is_some(), "{name} isn't registered");
|
||||
}
|
||||
}
|
||||
|
||||
/// Security: CUMIPMT and CUMPRINC loop over their periods once per lifted element; the
|
||||
/// periods of all elements are added up first, so an over-budget call runs none of them.
|
||||
#[test]
|
||||
fn lifted_period_loops_stop_past_their_work_budget() {
|
||||
use gridcraft_core::Array;
|
||||
let ends = |len: usize, end: f64| av(Array::filled(len, 1, nv(end)).into());
|
||||
let args = |len: usize, end: f64| vec![n(0.01), n(1e7), n(1000.0), n(1.0), ends(len, end), n(0.0)];
|
||||
// 51 elements of 1e7 periods each is past 5e8.
|
||||
is_err(ev("CUMIPMT", args(51, 1e7)), CellError::Num);
|
||||
is_err(ev("CUMPRINC", args(51, 1e7)), CellError::Num);
|
||||
// Numeric text is coerced by the function, so its periods are charged the same.
|
||||
let text_ends = av(Array::filled(51, 1, Value::text("10000000")).into());
|
||||
is_err(ev("CUMIPMT", vec![n(0.01), n(1e7), n(1000.0), n(1.0), text_ends, n(0.0)]), CellError::Num);
|
||||
let out = ev("CUMIPMT", args(2, 12.0));
|
||||
assert_eq!(rows_of(&out).len(), 2);
|
||||
assert!(matches!(rows_of(&out).first().and_then(|r| r.first()), Some(Value::Number(x)) if *x < 0.0));
|
||||
}
|
||||
|
||||
/// Security: numeric text is parsed once per lifted element even when the call is refused; the
|
||||
/// characters read are charged, so a long text repeated down a column can't cost gigabytes of parsing.
|
||||
#[test]
|
||||
fn lifted_period_loops_charge_the_text_they_parse() {
|
||||
use gridcraft_core::Array;
|
||||
// 20,000 elements x 32,000 characters is past 5e8 though no call reaches its loop (rate is negative).
|
||||
let long = Value::text(format!("{}5", "0".repeat(32_000)));
|
||||
let ends = av(Array::filled(20_000, 1, long).into());
|
||||
is_err(ev("CUMIPMT", vec![n(-0.01), n(10.0), n(1000.0), n(1.0), ends, n(0.0)]), CellError::Num);
|
||||
// A short text period costs next to nothing.
|
||||
let ends = av(Array::filled(3, 1, Value::text("12")).into());
|
||||
assert_eq!(rows_of(&ev("CUMIPMT", vec![n(0.01), n(20.0), n(1000.0), n(1.0), ends, n(0.0)])).len(), 3);
|
||||
}
|
||||
|
||||
/// Text after the first argument that fails to coerce is never read, so it is not charged: the
|
||||
/// elements keep their own errors instead of one budget `#NUM!`.
|
||||
#[test]
|
||||
fn lifted_period_loops_charge_only_the_text_they_reach() {
|
||||
use gridcraft_core::Array;
|
||||
let rates = av(Array::filled(20_000, 1, Value::text("x")).into());
|
||||
let long = Value::text(format!("{}5", "0".repeat(32_000)));
|
||||
let out = ev("CUMIPMT", vec![rates, n(10.0), n(1000.0), n(1.0), av(long), n(0.0)]);
|
||||
assert!(rows_of(&out).iter().all(|r| r.first() == Some(&Value::Error(CellError::Value))));
|
||||
}
|
||||
|
||||
/// A call the function refuses before its loop (here: end period past the period count) is
|
||||
/// not charged, so rejected elements can't push a valid one over the budget.
|
||||
#[test]
|
||||
fn lifted_period_loops_do_not_charge_rejected_calls() {
|
||||
use gridcraft_core::Array;
|
||||
let mut ends = vec![nv(1e7 + 1.0); 60];
|
||||
ends.push(nv(12.0));
|
||||
let ends = av(Array::new(ends.len(), 1, ends).unwrap_or_else(|| panic!("shape")).into());
|
||||
let out = ev("CUMIPMT", vec![n(0.01), n(1e7), n(1000.0), n(1.0), ends, n(0.0)]);
|
||||
let rows = rows_of(&out);
|
||||
assert_eq!(rows.len(), 61);
|
||||
assert!(matches!(rows.last().and_then(|r| r.first()), Some(Value::Number(x)) if *x < 0.0));
|
||||
}
|
||||
|
||||
/// Security: an array-producing function lifted over a computed array builds each element's
|
||||
/// whole result before keeping one cell; their cells count against the budget.
|
||||
#[test]
|
||||
fn lifted_array_results_count_against_the_budget() {
|
||||
use gridcraft_core::Array;
|
||||
let spec = crate::lookup("MUNIT").unwrap_or_else(|| panic!("MUNIT isn't registered"));
|
||||
let dims = |n: usize| [av(Array::filled(n, 1, nv(10.0)).into())];
|
||||
// Ten 10x10 identity matrices are 1,000 cells.
|
||||
let out = super::call_lifted_within(spec, &dims(10), &mut TestCtx::default(), 1_010);
|
||||
assert_eq!(rows_of(&out), vec![vec![nv(1.0)]; 10]);
|
||||
is_err(super::call_lifted_within(spec, &dims(11), &mut TestCtx::default(), 1_010), CellError::Num);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn value_params_reject_multi_cell_references() {
|
||||
let s = FnSpec { value_args: &[true, false], ..spec() };
|
||||
|
||||
@@ -30,27 +30,17 @@ fn check_len(s: String) -> R<Value> {
|
||||
|
||||
/// Pushes `piece` onto `out`, failing once the result exceeds the cell limit.
|
||||
fn push_capped(out: &mut String, piece: &str) -> R<()> {
|
||||
// Checked before copying, so one oversized piece is refused without being appended.
|
||||
if out.len().saturating_add(piece.len()) > MAX_TEXT * 4 {
|
||||
out.push_str(piece);
|
||||
if out.len() > MAX_TEXT * 4 {
|
||||
return Err(CellError::Value);
|
||||
}
|
||||
out.push_str(piece);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// `v.to_text()` without copying text values.
|
||||
fn piece(v: &Value) -> R<std::borrow::Cow<'_, str>> {
|
||||
match v {
|
||||
Value::Text(t) => Ok(std::borrow::Cow::Borrowed(t)),
|
||||
Value::Array(a) => a.data.first().map_or(Ok(std::borrow::Cow::Borrowed("")), piece),
|
||||
_ => v.to_text().map(std::borrow::Cow::Owned),
|
||||
}
|
||||
}
|
||||
|
||||
fn concatenate(a: &[Arg], _c: &mut dyn Ctx) -> R<Value> {
|
||||
let mut out = String::new();
|
||||
for x in a {
|
||||
push_capped(&mut out, &piece(&scalar(x))?)?;
|
||||
push_capped(&mut out, &scalar(x).to_text()?)?;
|
||||
}
|
||||
check_len(out)
|
||||
}
|
||||
@@ -59,49 +49,31 @@ fn concat(a: &[Arg], _c: &mut dyn Ctx) -> R<Value> {
|
||||
let mut out = String::new();
|
||||
for x in a {
|
||||
for v in as_array(&x.value).iter() {
|
||||
push_capped(&mut out, &piece(v)?)?;
|
||||
push_capped(&mut out, &v.to_text()?)?;
|
||||
}
|
||||
}
|
||||
check_len(out)
|
||||
}
|
||||
|
||||
/// The error `v.to_text()` would give, found without building any text.
|
||||
fn text_error(v: &Value) -> Option<CellError> {
|
||||
match v {
|
||||
Value::Error(e) => Some(*e),
|
||||
Value::Array(a) => a.data.first().and_then(text_error),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
fn textjoin(a: &[Arg], _c: &mut dyn Ctx) -> R<Value> {
|
||||
// Errors are found first, in argument order, so they win as before; text is then built one
|
||||
// piece at a time into the capped output, so many references to one long text (or a long
|
||||
// delimiter list) stop at the cap instead of first copying every piece.
|
||||
let delims = as_array(&arg(a, 0)?.value);
|
||||
if let Some(e) = delims.iter().find_map(text_error) {
|
||||
return Err(e);
|
||||
}
|
||||
let delims: Vec<String> = as_array(&arg(a, 0)?.value).iter().map(|v| v.to_text()).collect::<R<_>>()?;
|
||||
let ignore = boolean(a, 1)?;
|
||||
let items: Vec<_> = a.iter().skip(2).map(|x| as_array(&x.value)).collect();
|
||||
if let Some(e) = items.iter().flat_map(|x| x.iter()).find_map(text_error) {
|
||||
return Err(e);
|
||||
let mut items = Vec::new();
|
||||
for x in a.iter().skip(2) {
|
||||
for v in as_array(&x.value).iter() {
|
||||
let s = v.to_text()?;
|
||||
if ignore && s.is_empty() {
|
||||
continue;
|
||||
}
|
||||
items.push(s);
|
||||
}
|
||||
}
|
||||
let mut out = String::new();
|
||||
let mut joined = 0usize;
|
||||
for v in items.iter().flat_map(|x| x.iter()) {
|
||||
let s = piece(v)?;
|
||||
if ignore && s.is_empty() {
|
||||
continue;
|
||||
for (i, s) in items.iter().enumerate() {
|
||||
if i > 0 && !delims.is_empty() {
|
||||
push_capped(&mut out, &delims[(i - 1) % delims.len()])?;
|
||||
}
|
||||
if joined > 0
|
||||
&& !delims.data.is_empty()
|
||||
&& let Some(d) = delims.data.get((joined - 1) % delims.data.len())
|
||||
{
|
||||
push_capped(&mut out, &piece(d)?)?;
|
||||
}
|
||||
push_capped(&mut out, &s)?;
|
||||
joined += 1;
|
||||
push_capped(&mut out, s)?;
|
||||
}
|
||||
check_len(out)
|
||||
}
|
||||
@@ -1211,22 +1183,6 @@ mod tests {
|
||||
assert_eq!(rows_of(&ev("CONCATENATE", vec![av(row_t(&["a", "b"])), t("x")])), vec![vec![tv("ax"), tv("bx")]]);
|
||||
}
|
||||
|
||||
/// Security: TEXTJOIN builds its result piece by piece and stops at the text cap, rather
|
||||
/// than first copying every input (100,000 references to one 32,767-character text were
|
||||
/// 3 GB of copies). Errors among the inputs still win, in argument order.
|
||||
#[test]
|
||||
fn textjoin_stops_at_the_text_cap() {
|
||||
use gridcraft_core::Array;
|
||||
let long = tv(&"x".repeat(32_767));
|
||||
let many = || av(Array::filled(100_000, 1, long.clone()).into());
|
||||
is_err(ev("TEXTJOIN", vec![t(","), b(true), many()]), CellError::Value);
|
||||
is_err(ev("TEXTJOIN", vec![av(Array::filled(1, 100_000, long.clone()).into()), b(false), t("a"), t("b")]), CellError::Value);
|
||||
is_err(ev("TEXTJOIN", vec![t(","), b(true), many(), e(CellError::Div0)]), CellError::Div0);
|
||||
is_err(ev("TEXTJOIN", vec![av(arr(vec![vec![tv(","), Value::Error(CellError::NA)]])), b(true), t("a")]), CellError::NA);
|
||||
// Delimiters cycle and are converted only where used.
|
||||
is_text(ev("TEXTJOIN", vec![av(arr(vec![vec![nv(1.0), tv(";")]])), b(false), t("a"), t("b"), t("c"), t("d")]), "a1b;c1d");
|
||||
}
|
||||
|
||||
fn row_t(xs: &[&str]) -> Value {
|
||||
arr(vec![xs.iter().map(|x| tv(x)).collect()])
|
||||
}
|
||||
|
||||
@@ -496,9 +496,6 @@ pub fn read_csv_with_report(bytes: &[u8], opts: &CsvOptions) -> Result<(Workbook
|
||||
let mut styles = std::mem::take(&mut wb.styles);
|
||||
let mut fmt_cache: Vec<(&'static str, StyleId)> = vec![];
|
||||
let mut row: u32 = 0;
|
||||
// The bounding box of the non-empty cells, which is the sheet's used range.
|
||||
let mut used: Option<(u32, u32, u32, u32)> = None;
|
||||
let mut too_many = false;
|
||||
parse_records(&text, delim, quote, |rec| {
|
||||
if row >= MAX_ROWS {
|
||||
return false;
|
||||
@@ -512,8 +509,6 @@ pub fn read_csv_with_report(bytes: &[u8], opts: &CsvOptions) -> Result<(Workbook
|
||||
continue;
|
||||
}
|
||||
let pos = CellRef::new(row, col as u32);
|
||||
let (r0, c0, c1) = used.map_or((row, col as u32, col as u32), |(r0, c0, _, c1)| (r0, c0.min(col as u32), c1.max(col as u32)));
|
||||
used = Some((r0, c0, row, c1));
|
||||
let cell = if opts.parse_values {
|
||||
let rule = date_columns.get(col).map_or(DateRule::NoDates, |(rule, _)| *rule);
|
||||
let p = read_field(&f, opts.date_system, rule);
|
||||
@@ -534,19 +529,9 @@ pub fn read_csv_with_report(bytes: &[u8], opts: &CsvOptions) -> Result<(Workbook
|
||||
};
|
||||
sheet.cells.set(pos, cell);
|
||||
}
|
||||
// Stop at the first record that takes the used range past the limit, before more is stored.
|
||||
if let (Some(max), Some((r0, c0, r1, c1))) = (opts.max_used_cells, used)
|
||||
&& u64::from(r1 - r0 + 1) * u64::from(c1 - c0 + 1) > max
|
||||
{
|
||||
too_many = true;
|
||||
return false;
|
||||
}
|
||||
row += 1;
|
||||
true
|
||||
});
|
||||
if too_many {
|
||||
return Err(IoError::TooLarge(format!("the CSV's used range is over the limit of {} cells", opts.max_used_cells.unwrap_or(0))));
|
||||
}
|
||||
wb.styles = styles;
|
||||
wb.sheets = vec![Arc::new(sheet)];
|
||||
Ok((wb, report))
|
||||
|
||||
@@ -231,14 +231,11 @@ pub struct CsvOptions {
|
||||
pub date_system: DateSystem,
|
||||
/// Interpret fields like typed input (numbers, dates, booleans…); otherwise keep text.
|
||||
pub parse_values: bool,
|
||||
/// Refuse (with [`IoError::TooLarge`], while reading) a file whose used range, from its first to
|
||||
/// its last non-empty cell, would pass this many cells; `None` for no limit.
|
||||
pub max_used_cells: Option<u64>,
|
||||
}
|
||||
|
||||
impl Default for CsvOptions {
|
||||
fn default() -> Self {
|
||||
CsvOptions { delimiter: b',', quote: b'"', date_system: DateSystem::D1900, parse_values: true, max_used_cells: None }
|
||||
CsvOptions { delimiter: b',', quote: b'"', date_system: DateSystem::D1900, parse_values: true }
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -406,18 +406,3 @@ fn parser_stops_collecting_fields_at_max_cols() {
|
||||
});
|
||||
assert_eq!(lens, vec![MAX_COLS as usize]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn csv_used_range_limit_is_enforced_while_reading() {
|
||||
let opts = |max| CsvOptions { max_used_cells: Some(max), ..Default::default() };
|
||||
// 3 rows x 3 columns: exactly at the limit reads, one cell over is refused.
|
||||
let dense = b"1,2,3\n4,5,6\n7,8,9\n";
|
||||
assert!(read_csv(dense, &opts(9)).is_ok());
|
||||
assert!(matches!(read_csv(dense, &opts(8)), Err(IoError::TooLarge(_))));
|
||||
// The limit is on the used range: empty leading rows, columns and trailing lines are free.
|
||||
assert!(read_csv(b"\n\n,,x,y\n,,z,w\n\n\n", &opts(4)).is_ok());
|
||||
// A wide sparse row against a tall one: refused once the box passes the limit.
|
||||
assert!(matches!(read_csv(b"a\nb\nc\n,,,,d\n", &opts(10)), Err(IoError::TooLarge(_))));
|
||||
// No limit by default.
|
||||
assert!(read_csv(dense, &CsvOptions::default()).is_ok());
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user