Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lib.generators.toPlist: escape XML syntax in strings & keys #356502

Merged
merged 1 commit into from
Dec 23, 2024
+92 −8
Merged

lib.generators.toPlist: escape XML syntax in strings & keys #356502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions lib/generators.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ let
split
toJSON
typeOf
escapeXML
;

## -- HELPER FUNCTIONS & DEFAULTS --
Expand Down Expand Up @@ -548,13 +549,17 @@ in rec {

# Inputs

Options
: Empty set, there may be configuration options in the future
Structured function argument

: escape (optional, default: `false`)
: If this option is true, XML special characters are escaped in string values and keys

Value
: The value to be converted to Plist
*/
toPlist = {}: v: let
toPlist = {
escape ? false
}: v: let
expr = ind: x:
if x == null then "" else
if isBool x then bool ind x else
Expand All @@ -568,10 +573,12 @@ in rec {

literal = ind: x: ind + x;

maybeEscapeXML = if escape then escapeXML else x: x;

bool = ind: x: literal ind (if x then "<true/>" else "<false/>");
int = ind: x: literal ind "<integer>${toString x}</integer>";
str = ind: x: literal ind "<string>${x}</string>";
key = ind: x: literal ind "<key>${x}</key>";
str = ind: x: literal ind "<string>${maybeEscapeXML x}</string>";
key = ind: x: literal ind "<key>${maybeEscapeXML x}</key>";
float = ind: x: literal ind "<real>${toString x}</real>";

indent = ind: expr "\t${ind}";
Expand All @@ -597,7 +604,10 @@ in rec {
(expr "\t${ind}" value)
]) x));

in ''<?xml version="1.0" encoding="UTF-8"?>
in
# TODO: As discussed in #356502, deprecated functionality should be removed sometime after 25.11.
lib.warnIf (!escape && lib.oldestSupportedReleaseIsAtLeast 2505) "Using `lib.generators.toPlist` without `escape = true` is deprecated"
''<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
${expr "" v}
Expand Down
28 changes: 26 additions & 2 deletions lib/tests/misc.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1635,7 +1635,7 @@ runTests {
expected = "«foo»";
};

testToPlist = {
testToPlistUnescaped = {
expr = mapAttrs (const (generators.toPlist { })) {
value = {
nested.values = {
Expand All @@ -1651,10 +1651,34 @@ runTests {
emptylist = [];
attrs = { foo = null; "foo b/ar" = "baz"; };
emptyattrs = {};
"keys are not <escaped>" = "and < neither are string values";
};
};
};
expected = { value = builtins.readFile ./test-to-plist-expected.plist; };
expected = { value = builtins.readFile ./test-to-plist-unescaped-expected.plist; };
};

testToPlistEscaped = {
expr = mapAttrs (const (generators.toPlist { escape = true; })) {
value = {
nested.values = {
int = 42;
float = 0.1337;
bool = true;
emptystring = "";
string = "fn\${o}\"r\\d";
newlinestring = "\n";
path = /. + "/foo";
null_ = null;
list = [ 3 4 "test" ];
emptylist = [];
attrs = { foo = null; "foo b/ar" = "baz"; };
emptyattrs = {};
"keys are <escaped>" = "and < so are string values";
};
};
};
expected = { value = builtins.readFile ./test-to-plist-escaped-expected.plist; };
};

testToLuaEmptyAttrSet = {
Expand Down
48 changes: 48 additions & 0 deletions lib/tests/test-to-plist-escaped-expected.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>nested</key>
<dict>
<key>values</key>
<dict>
<key>attrs</key>
<dict>
<key>foo b/ar</key>
<string>baz</string>
</dict>
<key>bool</key>
<true/>
<key>emptyattrs</key>
<dict>

</dict>
<key>emptylist</key>
<array>

</array>
<key>emptystring</key>
<string></string>
<key>float</key>
<real>0.133700</real>
<key>int</key>
<integer>42</integer>
<key>keys are &lt;escaped&gt;</key>
<string>and &lt; so are string values</string>
<key>list</key>
<array>
<integer>3</integer>
<integer>4</integer>
<string>test</string>
</array>
<key>newlinestring</key>
<string>
</string>
<key>path</key>
<string>/foo</string>
<key>string</key>
<string>fn${o}&quot;r\d</string>
</dict>
</dict>
</dict>
</plist>
2 changes: 2 additions & 0 deletions lib/tests/test-to-plist-expected.plist → ...ts/test-to-plist-unescaped-expected.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
<real>0.133700</real>
<key>int</key>
<integer>42</integer>
<key>keys are not <escaped></key>
<string>and < neither are string values</string>
<key>list</key>
<array>
<integer>3</integer>
Expand Down
Loading