phasing out patterns with side effects

- add ssf test to actions - support for threaded comments (fixes #2542)
SheetJS · Mar 14, 2022 · 9a3294c · 9a3294c
1 parent f443aa8
commit 9a3294c
Show file tree

Hide file tree

Showing 61 changed files with 2,555 additions and 1,719 deletions.
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
@@ -82,6 +82,7 @@ jobs:
       - run: make init
       - run: 'cd test_files; make all; cd -'
       - run: npm run tests-only
+      - run: 'cd packages/ssf; npm install; npm run tests-only; cd -'
 
   node:
     name: 'node 4+'

diff --git a/.github/workflows/node-iojs.yml b/.github/workflows/node-iojs.yml
@@ -35,6 +35,7 @@ jobs:
       - run: make init
       - run: 'cd test_files; make all; cd -'
       - run: npm run tests-only
+      #- run: 'cd packages/ssf; npm run tests-only; cd -'
 
   node:
     name: 'io.js'

diff --git a/.github/workflows/node-zero.yml b/.github/workflows/node-zero.yml
@@ -51,6 +51,7 @@ jobs:
       - run: make init
       - run: 'cd test_files; make all; cd -'
       - run: npm run tests-only
+      #- run: 'cd packages/ssf; npm run tests-only; cd -'
 
 #  unstable:
 #    needs: [matrix, stable]

diff --git a/README.md b/README.md
@@ -3082,6 +3082,26 @@ ws.A2.c.hidden = true;
 ws.A2.c.push({a:"SheetJS", t:"This comment will be hidden"});
 ```
 
+
+_Threaded Comments_
+
+Introduced in Excel 365, threaded comments are plain text comment snippets with
+author metadata and parent references. They are supported in XLSX and XLSB.
+
+To mark a comment as threaded, each comment part must have a true `T` property:
+
+```js
+if(!ws.A1.c) ws.A1.c = [];
+ws.A1.c.push({a:"SheetJS", t:"This is not threaded"});
+
+if(!ws.A2.c) ws.A2.c = [];
+ws.A2.c.hidden = true;
+ws.A2.c.push({a:"SheetJS", t:"This is threaded", T: true});
+ws.A2.c.push({a:"JSSheet", t:"This is also threaded", T: true});
+```
+
+There is no Active Directory or Office 365 metadata associated with authors in a thread.
+
 #### Sheet Visibility
 
 Excel enables hiding sheets in the lower tab bar.  The sheet data is stored in

diff --git a/bin/xlsx.njs b/bin/xlsx.njs
@@ -154,6 +154,7 @@ if(program.all) {
 	opts.cellStyles = true;
 	opts.sheetStubs = true;
 	opts.cellDates = true;
+	wopts.cellFormula = true;
 	wopts.cellStyles = true;
 	wopts.sheetStubs = true;
 	wopts.bookVBA = true;

diff --git a/bits/22_xmlutils.js b/bits/22_xmlutils.js
@@ -253,6 +253,7 @@ var XMLNS = ({
 	EXT_PROPS: "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties",
 	CT: 'http://schemas.openxmlformats.org/package/2006/content-types',
 	RELS: 'http://schemas.openxmlformats.org/package/2006/relationships',
+	TCMNT: 'http://schemas.microsoft.com/office/spreadsheetml/2018/threadedcomments',
 	'dc': 'http://purl.org/dc/elements/1.1/',
 	'dcterms': 'http://purl.org/dc/terms/',
 	'dcmitype': 'http://purl.org/dc/dcmitype/',

diff --git a/bits/29_xlsenum.js b/bits/29_xlsenum.js
@@ -101,9 +101,6 @@ var SummaryPIDSI = {
 	/*::[*/0x72627262/*::]*/: {}
 };
 
-var DocSummaryRE/*:{[key:string]:string}*/ = evert_key(DocSummaryPIDDSI, "n");
-var SummaryRE/*:{[key:string]:string}*/ = evert_key(SummaryPIDSI, "n");
-
 /* [MS-XLS] 2.4.63 Country/Region codes */
 var CountryEnum = {
 	/*::[*/0x0001/*::]*/: "US", // United States

diff --git a/bits/30_ctype.js b/bits/30_ctype.js
@@ -49,6 +49,8 @@ var ct2type/*{[string]:string}*/ = ({
 	/* Comments */
 	"application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml": "comments",
 	"application/vnd.ms-excel.comments": "comments",
+	"application/vnd.ms-excel.threadedcomments+xml": "threadedcomments",
+	"application/vnd.ms-excel.person+xml": "people",
 
 	/* Metadata (Stock/Geography and Dynamic Array) */
 	"application/vnd.openxmlformats-officedocument.spreadsheetml.sheetMetadata+xml": "metadata",
@@ -223,9 +225,9 @@ var CT_LIST = {
 function new_ct()/*:any*/ {
 	return ({
 		workbooks:[], sheets:[], charts:[], dialogs:[], macros:[],
-		rels:[], strs:[], comments:[], links:[],
+		rels:[], strs:[], comments:[], threadedcomments:[], links:[],
 		coreprops:[], extprops:[], custprops:[], themes:[], styles:[],
-		calcchains:[], vba: [], drawings: [], metadata: [],
+		calcchains:[], vba: [], drawings: [], metadata: [], people:[],
 		TODO:[], xmlns: "" }/*:any*/);
 }
 
@@ -259,32 +261,30 @@ var CTYPE_XML_ROOT = writextag('Types', null, {
 	'xmlns:xsi': XMLNS.xsi
 });
 
-var CTYPE_DEFAULTS = [
-	['xml', 'application/xml'],
-	['bin', 'application/vnd.ms-excel.sheet.binary.macroEnabled.main'],
-	['vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing'],
-	['data', 'application/vnd.openxmlformats-officedocument.model+data'],
-	/* from test files */
-	['bmp', 'image/bmp'],
-	['png', 'image/png'],
-	['gif', 'image/gif'],
-	['emf', 'image/x-emf'],
-	['wmf', 'image/x-wmf'],
-	['jpg', 'image/jpeg'], ['jpeg', 'image/jpeg'],
-	['tif', 'image/tiff'], ['tiff', 'image/tiff'],
-	['pdf', 'application/pdf'],
-	['rels', 'application/vnd.openxmlformats-package.relationships+xml']
-].map(function(x) {
-	return writextag('Default', null, {'Extension':x[0], 'ContentType': x[1]});
-});
-
 function write_ct(ct, opts)/*:string*/ {
 	var type2ct/*{[string]:Array<string>}*/ = evert_arr(ct2type);
 
 	var o/*:Array<string>*/ = [], v;
 	o[o.length] = (XML_HEADER);
 	o[o.length] = (CTYPE_XML_ROOT);
-	o = o.concat(CTYPE_DEFAULTS);
+	o = o.concat([
+		['xml', 'application/xml'],
+		['bin', 'application/vnd.ms-excel.sheet.binary.macroEnabled.main'],
+		['vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing'],
+		['data', 'application/vnd.openxmlformats-officedocument.model+data'],
+		/* from test files */
+		['bmp', 'image/bmp'],
+		['png', 'image/png'],
+		['gif', 'image/gif'],
+		['emf', 'image/x-emf'],
+		['wmf', 'image/x-wmf'],
+		['jpg', 'image/jpeg'], ['jpeg', 'image/jpeg'],
+		['tif', 'image/tiff'], ['tiff', 'image/tiff'],
+		['pdf', 'application/pdf'],
+		['rels', 'application/vnd.openxmlformats-package.relationships+xml']
+	].map(function(x) {
+		return writextag('Default', null, {'Extension':x[0], 'ContentType': x[1]});
+	}));
 
 	/* only write first instance */
 	var f1 = function(w) {
@@ -325,8 +325,10 @@ function write_ct(ct, opts)/*:string*/ {
 	['coreprops', 'extprops', 'custprops'].forEach(f3);
 	f3('vba');
 	f3('comments');
+	f3('threadedcomments');
 	f3('drawings');
 	f2('metadata');
+	f3('people');
 	if(o.length>2){ o[o.length] = ('</Types>'); o[1]=o[1].replace("/>",">"); }
 	return o.join("");
 }
diff --git a/bits/31_rels.js b/bits/31_rels.js
@@ -9,9 +9,31 @@ var RELS = ({
 	XLINK: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/externalLink",
 	CXML: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml",
 	CXMLP: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXmlProps",
+	CMNT: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments",
+	CORE_PROPS: "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties",
+	EXT_PROPS: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties',
+	CUST_PROPS: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties',
+	SST: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings",
+	STY: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
+	THEME: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme",
+	CHART: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart",
+	CHARTEX: "http://schemas.microsoft.com/office/2014/relationships/chartEx",	
+	CS: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartsheet",
+	WS: [
+		"http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet",
+		"http://purl.oclc.org/ooxml/officeDocument/relationships/worksheet"
+	],
+	DS: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/dialogsheet",
+	MS: "http://schemas.microsoft.com/office/2006/relationships/xlMacrosheet",
+	IMG: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
+	DRAW: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing",
+	XLMETA: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sheetMetadata",
+	TCMNT: "http://schemas.microsoft.com/office/2017/10/relationships/threadedComment",
+	PEOPLE: "http://schemas.microsoft.com/office/2017/10/relationships/person",
 	VBA: "http://schemas.microsoft.com/office/2006/relationships/vbaProject"
 }/*:any*/);
 
+
 /* 9.3.3 Representing Relationships */
 function get_rels_path(file/*:string*/)/*:string*/ {
 	var n = file.lastIndexOf("/");

diff --git a/bits/33_coreprops.js b/bits/33_coreprops.js
@@ -18,8 +18,6 @@ var CORE_PROPS/*:Array<Array<string> >*/ = [
 	["dcterms:modified", "ModifiedDate", 'date']
 ];
 
-RELS.CORE_PROPS  = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties';
-
 var CORE_PROPS_REGEX/*:Array<RegExp>*/ = /*#__PURE__*/(function() {
 	var r = new Array(CORE_PROPS.length);
 	for(var i = 0; i < CORE_PROPS.length; ++i) {
@@ -43,15 +41,6 @@ function parse_core_props(data) {
 	return p;
 }
 
-var CORE_PROPS_XML_ROOT = writextag('cp:coreProperties', null, {
-	//'xmlns': XMLNS.CORE_PROPS,
-	'xmlns:cp': XMLNS.CORE_PROPS,
-	'xmlns:dc': XMLNS.dc,
-	'xmlns:dcterms': XMLNS.dcterms,
-	'xmlns:dcmitype': XMLNS.dcmitype,
-	'xmlns:xsi': XMLNS.xsi
-});
-
 function cp_doit(f, g, h, o, p) {
 	if(p[f] != null || g == null || g === "") return;
 	p[f] = g;
@@ -61,7 +50,14 @@ function cp_doit(f, g, h, o, p) {
 
 function write_core_props(cp, _opts) {
 	var opts = _opts || {};
-	var o = [XML_HEADER, CORE_PROPS_XML_ROOT], p = {};
+	var o = [XML_HEADER, writextag('cp:coreProperties', null, {
+		//'xmlns': XMLNS.CORE_PROPS,
+		'xmlns:cp': XMLNS.CORE_PROPS,
+		'xmlns:dc': XMLNS.dc,
+		'xmlns:dcterms': XMLNS.dcterms,
+		'xmlns:dcmitype': XMLNS.dcmitype,
+		'xmlns:xsi': XMLNS.xsi
+	})], p = {};
 	if(!cp && !opts.Props) return o.join("");
 
 	if(cp) {

diff --git a/bits/34_extprops.js b/bits/34_extprops.js
@@ -14,8 +14,6 @@ var EXT_PROPS/*:Array<Array<string> >*/ = [
 	["TitlesOfParts", "TitlesOfParts", "raw"]
 ];
 
-RELS.EXT_PROPS  = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties';
-
 var PseudoPropsPairs = [
 	"Worksheets",  "SheetNames",
 	"NamedRanges", "DefinedNames",
@@ -89,17 +87,15 @@ function parse_ext_props(data, p, opts) {
 	return p;
 }
 
-var EXT_PROPS_XML_ROOT = writextag('Properties', null, {
-	'xmlns': XMLNS.EXT_PROPS,
-	'xmlns:vt': XMLNS.vt
-});
-
 function write_ext_props(cp/*::, opts*/)/*:string*/ {
 	var o/*:Array<string>*/ = [], W = writextag;
 	if(!cp) cp = {};
 	cp.Application = "SheetJS";
 	o[o.length] = (XML_HEADER);
-	o[o.length] = (EXT_PROPS_XML_ROOT);
+	o[o.length] = (writextag('Properties', null, {
+		'xmlns': XMLNS.EXT_PROPS,
+		'xmlns:vt': XMLNS.vt
+	}));
 
 	EXT_PROPS.forEach(function(f) {
 		if(cp[f[1]] === undefined) return;

diff --git a/bits/35_custprops.js b/bits/35_custprops.js
@@ -1,6 +1,4 @@
 /* 15.2.12.2 Custom File Properties Part */
-RELS.CUST_PROPS  = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties';
-
 var custregex = /<[^>]+>[^<]*/g;
 function parse_cust_props(data/*:string*/, opts) {
 	var p = {}, name = "";
@@ -46,13 +44,11 @@ function parse_cust_props(data/*:string*/, opts) {
 	return p;
 }
 
-var CUST_PROPS_XML_ROOT = writextag('Properties', null, {
-	'xmlns': XMLNS.CUST_PROPS,
-	'xmlns:vt': XMLNS.vt
-});
-
 function write_cust_props(cp/*::, opts*/)/*:string*/ {
-	var o = [XML_HEADER, CUST_PROPS_XML_ROOT];
+	var o = [XML_HEADER, writextag('Properties', null, {
+		'xmlns': XMLNS.CUST_PROPS,
+		'xmlns:vt': XMLNS.vt
+	})];
 	if(!cp) return o.join("");
 	var pid = 1;
 	keys(cp).forEach(function custprop(k) { ++pid;

diff --git a/bits/36_xlsprops.js b/bits/36_xlsprops.js
@@ -31,9 +31,10 @@ var XLMLDocPropsMap = {
 	Identifier: 'Identifier', /* NOTE: missing from schema */
 	Language: 'Language' /* NOTE: missing from schema */
 };
-var evert_XLMLDPM = evert(XLMLDocPropsMap);
+var evert_XLMLDPM;
 
 function xlml_set_prop(Props, tag/*:string*/, val) {
+	if(!evert_XLMLDPM) evert_XLMLDPM = evert(XLMLDocPropsMap);
 	tag = evert_XLMLDPM[tag] || tag;
 	Props[tag] = val;
 }

diff --git a/bits/38_xlstypes.js b/bits/38_xlstypes.js
@@ -248,7 +248,7 @@ function parse_PropertySet(blob, PIDSI) {
 	blob.l = start_addr + size; /* step ahead to skip padding */
 	return PropH;
 }
-var XLSPSSkip = [ "CodePage", "Thumbnail", "_PID_LINKBASE", "_PID_HLINKS", "SystemIdentifier", "FMTID" ].concat(PseudoPropsPairs);
+var XLSPSSkip = [ "CodePage", "Thumbnail", "_PID_LINKBASE", "_PID_HLINKS", "SystemIdentifier", "FMTID" ]; //.concat(PseudoPropsPairs);
 function guess_property_type(val/*:any*/)/*:number*/ {
 	switch(typeof val) {
 		case "boolean": return 0x0B;
@@ -292,7 +292,7 @@ function write_PropertySet(entries, RE, PIDSI) {
 
 	for(i = 0; i < entries.length; ++i) {
 		if(RE && !RE[entries[i][0]]) continue;
-		if(XLSPSSkip.indexOf(entries[i][0]) > -1) continue;
+		if(XLSPSSkip.indexOf(entries[i][0]) > -1 || PseudoPropsPairs.indexOf(entries[i][0]) > -1) continue;
 		if(entries[i][1] == null) continue;
 
 		var val = entries[i][1], idx = 0;

diff --git a/bits/42_sstxml.js b/bits/42_sstxml.js
@@ -213,7 +213,6 @@ function parse_sst_xml(data/*:string*/, opts)/*:SST*/ {
 	return s;
 }
 
-RELS.SST = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings";
 var straywsregex = /^\s|\s$|[\t\n\r]/;
 function write_sst_xml(sst/*:SST*/, opts)/*:string*/ {
 	if(!opts.bookSST) return "";

diff --git a/bits/47_styxml.js b/bits/47_styxml.js
@@ -410,8 +410,6 @@ return function parse_sty_xml(data, themes, opts) {
 };
 })();
 
-RELS.STY = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles";
-
 function write_sty_xml(wb/*:Workbook*/, opts)/*:string*/ {
 	var o = [XML_HEADER, writextag('styleSheet', null, {
 		'xmlns': XMLNS_main[0],

diff --git a/bits/48_stybin.js b/bits/48_stybin.js
@@ -102,11 +102,12 @@ var XLSBFillPTNames = [
 	"gray125",
 	"gray0625"
 ];
-var rev_XLSBFillPTNames/*:EvertNumType*/ = (evert(XLSBFillPTNames)/*:any*/);
+var rev_XLSBFillPTNames/*:EvertNumType*/
 /* TODO: gradient fill representation */
 var parse_BrtFill = parsenoop;
 function write_BrtFill(fill, o) {
 	if(!o) o = new_buf(4*3 + 8*7 + 16*1);
+	if(!rev_XLSBFillPTNames) rev_XLSBFillPTNames = (evert(XLSBFillPTNames)/*:any*/);
 	var fls/*:number*/ = rev_XLSBFillPTNames[fill.patternType];
 	if(fls == null) fls = 0x28;
 	o.write_shift(4, fls);

diff --git a/bits/49_theme.js b/bits/49_theme.js
@@ -1,5 +1,3 @@
-RELS.THEME = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme";
-
 /* Even though theme layout is dk1 lt1 dk2 lt2, true order is lt1 dk1 lt2 dk2 */
 var XLSXThemeClrScheme = [
 	'</a:lt1>', '</a:dk1>', '</a:lt2>', '</a:dk2>',