fix(plist): decode formatted XML dictionary keys
This commit is contained in:
@@ -9,6 +9,10 @@ it.each([
|
||||
"<key>__proto__</key>",
|
||||
"<key><![CDATA[__proto__]]></key>",
|
||||
"<key>__proto__</key>",
|
||||
"<key >__proto__</key >",
|
||||
"<key\n>__proto__</key>",
|
||||
"<key>__proto__<!-- trailing comment --></key>",
|
||||
"<key><![CDATA[__proto__]]><!-- trailing comment --></key>",
|
||||
])("omits and counts a dictionary keyed %s", (key) => {
|
||||
const parsed = parseXmlPropertyList(
|
||||
plist(
|
||||
@@ -64,3 +68,56 @@ it("omits own __proto__ entries that JSON decoding creates", () => {
|
||||
omittedPrototypeKeys: 2,
|
||||
});
|
||||
});
|
||||
|
||||
it("preserves the pinned decoder's first-child key semantics", () => {
|
||||
const text = plist(
|
||||
"<dict><key>__pro<![CDATA[to__]]></key><string>kept</string><key>__proto__</key><string>omitted</string></dict>",
|
||||
);
|
||||
expect(parseXmlPropertyList(text)).toEqual({
|
||||
value: { __pro: "kept" },
|
||||
omittedPrototypeKeys: 1,
|
||||
});
|
||||
});
|
||||
|
||||
it("preserves OpenStep dictionary and array autodetection", () => {
|
||||
expect(
|
||||
parseXmlPropertyList(
|
||||
" { CFBundleExecutable = App; values = (one, two); __rea_prototype_key__ = kept; }",
|
||||
),
|
||||
).toEqual({
|
||||
value: {
|
||||
CFBundleExecutable: "App",
|
||||
values: ["one", "two"],
|
||||
__rea_prototype_key__: "kept",
|
||||
},
|
||||
omittedPrototypeKeys: 0,
|
||||
});
|
||||
expect(parseXmlPropertyList("(one, two)")).toEqual({
|
||||
value: ["one", "two"],
|
||||
omittedPrototypeKeys: 0,
|
||||
});
|
||||
});
|
||||
|
||||
it.each(["\n", "\r\n", "\r", "\u0085", "\u2028", "\u2029"])(
|
||||
"preserves unrelated source values around %j line endings",
|
||||
(newline) => {
|
||||
const text = plist(
|
||||
`<dict>${newline}<key>kept key</key><string>a b…c
d</string>${newline}<key${newline}>__proto__<!--tail--></key><string>omitted</string></dict>`,
|
||||
);
|
||||
expect(parseXmlPropertyList(text)).toEqual({
|
||||
value: { "kept\rkey": "a\rb\u0085c\u2028d" },
|
||||
omittedPrototypeKeys: 1,
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
it("locates sparse omitted keys across newline-dense source", () => {
|
||||
const lines = "\n".repeat(64 * 1024);
|
||||
const text = plist(
|
||||
`<dict>${lines}<key >__proto__</key><string>omitted</string><key>nested</key><dict>${lines}<key>__proto__<!--tail--></key><string>omitted</string><key>kept</key><true/></dict></dict>`,
|
||||
);
|
||||
expect(parseXmlPropertyList(text)).toEqual({
|
||||
value: { nested: { kept: true } },
|
||||
omittedPrototypeKeys: 2,
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { DOMParser, normalizeLineEndings } from "@xmldom/xmldom";
|
||||
import { parse } from "plist";
|
||||
|
||||
/** The dictionary key REA results cannot carry: validation strips it. */
|
||||
@@ -46,10 +47,6 @@ export const omitPrototypeKeys = (
|
||||
value: unknown,
|
||||
): PropertyListWithoutPrototypeKeys => withoutKey(value, PROTOTYPE_KEY);
|
||||
|
||||
// Comments and CDATA text are consumed whole so only element keys match.
|
||||
const KEY_TOKEN =
|
||||
/<!--[\s\S]*?-->|<!\[CDATA\[[\s\S]*?\]\]>|<key>([^<]*)<\/key>|<key><!\[CDATA\[([\s\S]*?)\]\]><\/key>/gu;
|
||||
|
||||
const XML_ENTITIES: Readonly<Record<string, string>> = {
|
||||
amp: "&",
|
||||
apos: "'",
|
||||
@@ -87,18 +84,54 @@ export const decodeXmlText = (text: string): string =>
|
||||
export const parseXmlPropertyList = (
|
||||
text: string,
|
||||
): PropertyListWithoutPrototypeKeys => {
|
||||
// The decoded text holds every key the decoder can produce, including
|
||||
// entity-encoded spellings of the placeholder, so no source key aliases it.
|
||||
// Decoding comment or CDATA text too can only lengthen the placeholder.
|
||||
const decoded = decodeXmlText(text);
|
||||
let placeholder = "__rea_prototype_key__";
|
||||
while (decoded.includes(placeholder)) placeholder = `_${placeholder}`;
|
||||
const substituted = text.replace(
|
||||
KEY_TOKEN,
|
||||
(token, plain?: string, cdata?: string) =>
|
||||
(plain === undefined ? cdata : decodeXmlText(plain)) === PROTOTYPE_KEY
|
||||
? `<key>${placeholder}</key>`
|
||||
: token,
|
||||
// Preserve the pinned decoder's existing OpenStep autodetection, also used
|
||||
// by app Info.plist resolution. Only XML needs the key-element substitution.
|
||||
const first = text.trimStart()[0];
|
||||
if (first === "{" || first === "(") return omitPrototypeKeys(parse(text));
|
||||
const { substituted, placeholder } = substitutePrototypeKeys(
|
||||
normalizeLineEndings(text),
|
||||
);
|
||||
return withoutKey(parse(substituted), placeholder);
|
||||
};
|
||||
|
||||
/** Locate keys with the same XML parser and first-child semantics as plist. */
|
||||
const substitutePrototypeKeys = (text: string) => {
|
||||
// Normalize only the literal line endings the pinned decoder normalizes.
|
||||
// Preserve character references in the source: serializing a DOM would turn
|
||||
// e.g. an encoded carriage return into a literal newline on the second parse.
|
||||
const document = new DOMParser().parseFromString(text, "text/xml");
|
||||
const keys = Array.from(document.getElementsByTagName("key"));
|
||||
const decodedKeys = new Set(keys.map((key) => key.firstChild?.nodeValue));
|
||||
let placeholder = "__rea_prototype_key__";
|
||||
while (decodedKeys.has(placeholder)) placeholder = `_${placeholder}`;
|
||||
|
||||
const omitted = keys
|
||||
.map((key) => key.firstChild)
|
||||
.filter((node) => node?.nodeValue === PROTOTYPE_KEY);
|
||||
if (omitted.length === 0) return { substituted: text, placeholder };
|
||||
|
||||
// xmldom uses one-based locators in document order. Scan forward only to
|
||||
// needed lines instead of retaining an offset for every source newline.
|
||||
let line = 1;
|
||||
let lineStart = 0;
|
||||
const parts: string[] = [];
|
||||
let cursor = 0;
|
||||
for (const node of omitted) {
|
||||
const nodeLine = node?.lineNumber;
|
||||
const column = node?.columnNumber;
|
||||
if (nodeLine === undefined || column === undefined)
|
||||
throw new TypeError("XML plist key has no source location");
|
||||
while (line < nodeLine) {
|
||||
const newline = text.indexOf("\n", lineStart);
|
||||
if (newline === -1)
|
||||
throw new TypeError("XML plist key has an invalid source location");
|
||||
lineStart = newline + 1;
|
||||
line += 1;
|
||||
}
|
||||
const offset = lineStart + column - 1;
|
||||
parts.push(text.slice(cursor, offset), `<![CDATA[${placeholder}]]>`);
|
||||
cursor = offset;
|
||||
}
|
||||
parts.push(text.slice(cursor));
|
||||
return { substituted: parts.join(""), placeholder };
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user