Trim whitespace/newline characters from <sparkle:releaseNotesLink> (#2944)

This fixes a regression introduced in Sparkle 2.9 when signed feeds were added. In our documentation we have suggested surrounding the release notes URL with newline/whitespace for pretty-print formatting reasons. However now that this bug surfaced, the documentation will be updated to remove the extraneous whitespace. Many developers generating appcasts programmatically or with generate_appcast will not run into this issue.
This commit is contained in:
Zorg authored and GitHub committed 2026-10-24 12:34:21 -07:00
1 parent 19688c1a0a
commit 76583dcf69
4 files changed
+23 -29

No files matched your search

+6 -18
View File
@@ -8,12 +8,8 @@
<title>Version 2.0 (2 bugs fixed; 3 new features)</title>
<link>https://sparkle-project.org</link>
<sparkle:version>2.0</sparkle:version>
<sparkle:releaseNotesLink>
https://you.com/app/2.0.html
</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>
https://you.com/app/changelog.php
</sparkle:fullReleaseNotesLink>
<sparkle:releaseNotesLink>https://you.com/app/2.0.html</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>https://you.com/app/changelog.php</sparkle:fullReleaseNotesLink>
<pubDate>Wed, 09 Jan 2006 19:20:11 +0000</pubDate>
<enclosure url="https://you.com/app/Your%20Great%20App%202.0.zip" length="1623481" type="application/octet-stream" sparkle:edSignature="WVyVJpOx+a5+vNWJVY79TRjFKveNk+VhGJf2iti4CZtJsJewIUGvh/1AKKEAFbH1qUwx+vro1ECuzOsMmumoBA==" />
<sparkle:minimumSystemVersion>12.0</sparkle:minimumSystemVersion>
@@ -23,12 +19,8 @@
<title>Version 1.5 (8 bugs fixed; 2 new features)</title>
<link>https://sparkle-project.org</link>
<sparkle:version>1.5</sparkle:version>
<sparkle:releaseNotesLink>
https://you.com/app/1.5.html
</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>
https://you.com/app/changelog.php?up-to=1.5
</sparkle:fullReleaseNotesLink>
<sparkle:releaseNotesLink>https://you.com/app/1.5.html</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>https://you.com/app/changelog.php?up-to=1.5</sparkle:fullReleaseNotesLink>
<pubDate>Wed, 01 Jan 2006 12:20:11 +0000</pubDate>
<enclosure url="https://you.com/app/Your%20Great%20App%201.5.zip" length="1472893" type="application/octet-stream" sparkle:edSignature="pNFd7KbcQSu+Mq7UYrbQXTPq82luht2ACXm/r2utp1u/Uv/5hWqctdT2jwQgMejW7DRoeV/hVr6J4VdZYdwWDw==" />
<sparkle:minimumSystemVersion>12.0</sparkle:minimumSystemVersion>
@@ -38,12 +30,8 @@
<item>
<title>Version 1.4 (5 bugs fixed; 2 new features)</title>
<link>https://sparkle-project.org</link>
<sparkle:releaseNotesLink>
https://you.com/app/1.4.html
</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>
https://you.com/app/changelog.php?up-to=1.4
</sparkle:fullReleaseNotesLink>
<sparkle:releaseNotesLink>https://you.com/app/1.4.html</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>https://you.com/app/changelog.php?up-to=1.4</sparkle:fullReleaseNotesLink>
<sparkle:version>241</sparkle:version>
<sparkle:shortVersionString>1.4</sparkle:shortVersionString>
<pubDate>Wed, 25 Dec 2005 12:20:11 +0000</pubDate>
+2 -1
View File
@@ -145,7 +145,8 @@
[dict setObject:descriptionDict forKey:SURSSElementDescription];
}
} else if ([name isEqualToString:SUAppcastElementReleaseNotesLink]) {
NSString *releaseNotesLink = node.stringValue;
// Trim whitespace to maintain backwards compatibility
NSString *releaseNotesLink = [node.stringValue stringByTrimmingCharactersInSet:NSCharacterSet.whitespaceAndNewlineCharacterSet];
if (releaseNotesLink != nil) {
NSDictionary *attributes = [self attributesOfNode:(NSXMLElement *)node];
+8 -8
View File
@@ -567,10 +567,10 @@ static NSString *SPUSanitizeUntrustedVersionString(NSString *versionString, NSSt
processedInfoURL = [NSURL URLWithString:infoLinkURLString];
}
if ([processedInfoURL.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [processedInfoURL.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame) {
if (processedInfoURL != nil && ([processedInfoURL.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [processedInfoURL.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame)) {
infoURL = processedInfoURL;
} else {
SULog(SULogLevelError, @"%@ -%@ Info URL must have a http or https URL scheme.", NSStringFromClass([self class]), NSStringFromSelector(_cmd));
SULog(SULogLevelError, @"Info URL must have a http or https URL scheme: %@", infoLinkURLString);
}
}
}
@@ -622,11 +622,11 @@ static NSString *SPUSanitizeUntrustedVersionString(NSString *versionString, NSSt
fileURL = [NSURL URLWithString:fileURLString];
}
if ([fileURL.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [fileURL.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame) {
if (fileURL != nil && ([fileURL.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [fileURL.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame)) {
_fileURL = fileURL;
} else {
if (error) {
*error = @"File URLs must have a http or https URL scheme";
*error = [NSString stringWithFormat:@"File URL must have a http or https URL scheme: %@", fileURLString];
}
return nil;
}
@@ -825,10 +825,10 @@ static NSString *SPUSanitizeUntrustedVersionString(NSString *versionString, NSSt
} else {
url = [NSURL URLWithString:releaseNotesString];
}
if ([url.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [url.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame) {
if (url != nil && ([url.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [url.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame)) {
_releaseNotesURL = url;
} else {
SULog(SULogLevelError, @"Release notes must have a http or https URL scheme.");
SULog(SULogLevelError, @"Release notes must have a http or https URL scheme: %@", releaseNotesString);
_releaseNotesURL = nil;
}
} else if ([_itemDescription hasPrefix:@"http://"] || [_itemDescription hasPrefix:@"https://"]) { // if the description starts with http:// or https:// use that.
@@ -857,10 +857,10 @@ static NSString *SPUSanitizeUntrustedVersionString(NSString *versionString, NSSt
} else {
url = [NSURL URLWithString:fullReleaseNotesString];
}
if ([url.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [url.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame) {
if (url != nil && ([url.scheme caseInsensitiveCompare:@"http"] == NSOrderedSame || [url.scheme caseInsensitiveCompare:@"https"] == NSOrderedSame)) {
_fullReleaseNotesURL = url;
} else {
SULog(SULogLevelError, @"Full release notes must have a http or https URL scheme.");
SULog(SULogLevelError, @"Full release notes must have a http or https URL scheme: %@", fullReleaseNotesString);
_fullReleaseNotesURL = nil;
}
} else {
+7 -2
View File
@@ -13,8 +13,13 @@
<item>
<title>Version 2.0</title>
<pubDate>Sat, 26 Jul 2014 15:20:12 +0000</pubDate>
<sparkle:releaseNotesLink>http://sparkle-project.org/notes/relnote-2.0.txt</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>http://sparkle-project.org/fullnotes.txt</sparkle:fullReleaseNotesLink>
<!-- Test that whitespace/newlines are trimmed too -->
<sparkle:releaseNotesLink>
http://sparkle-project.org/notes/relnote-2.0.txt
</sparkle:releaseNotesLink>
<sparkle:fullReleaseNotesLink>
http://sparkle-project.org/fullnotes.txt
</sparkle:fullReleaseNotesLink>
<link>http://sparkle-project.org</link>
<enclosure url="http://sparkle-project.org/release-2.0.zip" sparkle:version="2.0" length="1346234" />
</item>