Skip to content

Commit

Permalink
[XML formats] Ensure elements are connected to DOM before further man…
Browse files Browse the repository at this point in the history 
…ipulation (#2806)

We are setting xmlns attributes at the root element but PHP would
still attach redundant ones to the DOM elements created with `createElementNS`.
That was because PHP reconciles namespace attributes when appending elements to DOM
but since we previously only attached the elements after all children were attached,
the reconciliation algorithm was not able to see the root element’s attributes.

To fix this, let’s attach each element to its parent immediately after it is created.
  • Loading branch information
@jtojnar
jtojnar authored Jun 9, 2022
1 parent 37f211a commit 1af6cbe
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 41 deletions.
45 changes: 22 additions & 23 deletions formats/AtomFormat.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ public function stringify(){
$document = new DomDocument('1.0', $this->getCharset());
$document->formatOutput = true;
$feed = $document->createElementNS(self::ATOM_NS, 'feed');
$feed->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:media', self::MRSS_NS);
$document->appendChild($feed);
$feed->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:media', self::MRSS_NS);

$title = $document->createElement('title');
$feed->appendChild($title);
$title->setAttribute('type', 'text');
$title->appendChild($document->createTextNode($extraInfos['name']));
$feed->appendChild($title);

$id = $document->createElement('id');
$id->appendChild($document->createTextNode($feedUrl));
$feed->appendChild($id);
$id->appendChild($document->createTextNode($feedUrl));

$uriparts = parse_url($uri);
if(!empty($extraInfos['icon'])) {
Expand All @@ -47,38 +47,38 @@ public function stringify(){
$iconUrl = $uriparts['scheme'] . '://' . $uriparts['host'] . '/favicon.ico';
}
$icon = $document->createElement('icon');
$icon->appendChild($document->createTextNode($iconUrl));
$feed->appendChild($icon);
$icon->appendChild($document->createTextNode($iconUrl));

$logo = $document->createElement('logo');
$logo->appendChild($document->createTextNode($iconUrl));
$feed->appendChild($logo);
$logo->appendChild($document->createTextNode($iconUrl));

$feedTimestamp = gmdate(DATE_ATOM, $this->lastModified);
$updated = $document->createElement('updated');
$updated->appendChild($document->createTextNode($feedTimestamp));
$feed->appendChild($updated);
$updated->appendChild($document->createTextNode($feedTimestamp));

// since we can't guarantee that all items have an author,
// a global feed author is mandatory
$feedAuthor = 'RSS-Bridge';
$author = $document->createElement('author');
$feed->appendChild($author);
$authorName = $document->createElement('name');
$authorName->appendChild($document->createTextNode($feedAuthor));
$author->appendChild($authorName);
$feed->appendChild($author);
$authorName->appendChild($document->createTextNode($feedAuthor));

$linkAlternate = $document->createElement('link');
$feed->appendChild($linkAlternate);
$linkAlternate->setAttribute('rel', 'alternate');
$linkAlternate->setAttribute('type', 'text/html');
$linkAlternate->setAttribute('href', $uri);
$feed->appendChild($linkAlternate);

$linkSelf = $document->createElement('link');
$feed->appendChild($linkSelf);
$linkSelf->setAttribute('rel', 'self');
$linkSelf->setAttribute('type', 'application/atom+xml');
$linkSelf->setAttribute('href', $feedUrl);
$feed->appendChild($linkSelf);

foreach($this->getItems() as $item) {
$entryTimestamp = $item->getTimestamp();
Expand Down Expand Up @@ -111,39 +111,40 @@ public function stringify(){
$entryContent = ' ';

$entry = $document->createElement('entry');
$feed->appendChild($entry);

$title = $document->createElement('title');
$entry->appendChild($title);
$title->setAttribute('type', 'html');
$title->appendChild($document->createTextNode($entryTitle));
$entry->appendChild($title);

$entryTimestamp = gmdate(DATE_ATOM, $entryTimestamp);
$published = $document->createElement('published');
$published->appendChild($document->createTextNode($entryTimestamp));
$entry->appendChild($published);
$published->appendChild($document->createTextNode($entryTimestamp));

$updated = $document->createElement('updated');
$updated->appendChild($document->createTextNode($entryTimestamp));
$entry->appendChild($updated);
$updated->appendChild($document->createTextNode($entryTimestamp));

$id = $document->createElement('id');
$id->appendChild($document->createTextNode($entryID));
$entry->appendChild($id);
$id->appendChild($document->createTextNode($entryID));

if (!empty($entryUri)) {
$entryLinkAlternate = $document->createElement('link');
$entry->appendChild($entryLinkAlternate);
$entryLinkAlternate->setAttribute('rel', 'alternate');
$entryLinkAlternate->setAttribute('type', 'text/html');
$entryLinkAlternate->setAttribute('href', $entryUri);
$entry->appendChild($entryLinkAlternate);
}

if (!empty($item->getAuthor())) {
$author = $document->createElement('author');
$entry->appendChild($author);
$authorName = $document->createElement('name');
$authorName->appendChild($document->createTextNode($item->getAuthor()));
$author->appendChild($authorName);
$entry->appendChild($author);
$authorName->appendChild($document->createTextNode($item->getAuthor()));
}

$content = $document->createElement('content');
Expand All @@ -153,25 +154,23 @@ public function stringify(){

foreach($item->getEnclosures() as $enclosure) {
$entryEnclosure = $document->createElement('link');
$entry->appendChild($entryEnclosure);
$entryEnclosure->setAttribute('rel', 'enclosure');
$entryEnclosure->setAttribute('type', getMimeType($enclosure));
$entryEnclosure->setAttribute('href', $enclosure);
$entry->appendChild($entryEnclosure);
}

foreach($item->getCategories() as $category) {
$entryCategory = $document->createElement('category');
$entryCategory->setAttribute('term', $category);
$entry->appendChild($entryCategory);
$entryCategory->setAttribute('term', $category);
}

if (!empty($item->thumbnail)) {
$thumbnail = $document->createElementNS(self::MRSS_NS, 'media:thumbnail');
$thumbnail->setAttribute('url', $item->thumbnail);
$thumbnail = $document->createElementNS(self::MRSS_NS, 'thumbnail');
$entry->appendChild($thumbnail);
$thumbnail->setAttribute('url', $item->thumbnail);
}

$feed->appendChild($entry);
}

$toReturn = $document->saveXML();
Expand Down
35 changes: 17 additions & 18 deletions formats/MrssFormat.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,26 +48,26 @@ public function stringify(){
$document = new DomDocument('1.0', $this->getCharset());
$document->formatOutput = true;
$feed = $document->createElement('rss');
$document->appendChild($feed);
$feed->setAttribute('version', '2.0');
$feed->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:atom', self::ATOM_NS);
$feed->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:media', self::MRSS_NS);
$document->appendChild($feed);

$channel = $document->createElement('channel');
$feed->appendChild($channel);

$title = $extraInfos['name'];
$channelTitle = $document->createElement('title');
$channelTitle->appendChild($document->createTextNode($title));
$channel->appendChild($channelTitle);
$channelTitle->appendChild($document->createTextNode($title));

$link = $document->createElement('link');
$link->appendChild($document->createTextNode($uri));
$channel->appendChild($link);
$link->appendChild($document->createTextNode($uri));

$description = $document->createElement('description');
$description->appendChild($document->createTextNode($extraInfos['name']));
$channel->appendChild($description);
$description->appendChild($document->createTextNode($extraInfos['name']));

$icon = $extraInfos['icon'];
if (!empty($icon) && in_array(substr($icon, -4), self::ALLOWED_IMAGE_EXT)) {
Expand All @@ -84,17 +84,17 @@ public function stringify(){
$feedImage->appendChild($iconLink);
}

$linkAlternate = $document->createElementNS(self::ATOM_NS, 'atom:link');
$linkAlternate = $document->createElementNS(self::ATOM_NS, 'link');
$channel->appendChild($linkAlternate);
$linkAlternate->setAttribute('rel', 'alternate');
$linkAlternate->setAttribute('type', 'text/html');
$linkAlternate->setAttribute('href', $uri);
$channel->appendChild($linkAlternate);

$linkSelf = $document->createElementNS(self::ATOM_NS, 'atom:link');
$linkSelf = $document->createElementNS(self::ATOM_NS, 'link');
$channel->appendChild($linkSelf);
$linkSelf->setAttribute('rel', 'self');
$linkSelf->setAttribute('type', 'application/atom+xml');
$linkSelf->setAttribute('href', $feedUrl);
$channel->appendChild($linkSelf);

foreach($this->getItems() as $item) {
$itemTimestamp = $item->getTimestamp();
Expand All @@ -113,51 +113,50 @@ public function stringify(){
$entryID = hash('sha1', $itemTitle . $itemContent);

$entry = $document->createElement('item');
$channel->appendChild($entry);

if (!empty($itemTitle)) {
$entryTitle = $document->createElement('title');
$entryTitle->appendChild($document->createTextNode($itemTitle));
$entry->appendChild($entryTitle);
$entryTitle->appendChild($document->createTextNode($itemTitle));
}

if (!empty($itemUri)) {
$entryLink = $document->createElement('link');
$entryLink->appendChild($document->createTextNode($itemUri));
$entry->appendChild($entryLink);
$entryLink->appendChild($document->createTextNode($itemUri));
}

$entryGuid = $document->createElement('guid');
$entryGuid->setAttribute('isPermaLink', $isPermaLink);
$entryGuid->appendChild($document->createTextNode($entryID));
$entry->appendChild($entryGuid);
$entryGuid->appendChild($document->createTextNode($entryID));

if (!empty($itemTimestamp)) {
$entryPublished = $document->createElement('pubDate');
$entryPublished->appendChild($document->createTextNode(gmdate(DATE_RFC2822, $itemTimestamp)));
$entry->appendChild($entryPublished);
$entryPublished->appendChild($document->createTextNode(gmdate(DATE_RFC2822, $itemTimestamp)));
}

if (!empty($itemContent)) {
$entryDescription = $document->createElement('description');
$entryDescription->appendChild($document->createTextNode($itemContent));
$entry->appendChild($entryDescription);
$entryDescription->appendChild($document->createTextNode($itemContent));
}

foreach($item->getEnclosures() as $enclosure) {
$entryEnclosure = $document->createElementNS(self::MRSS_NS, 'media:content');
$entryEnclosure = $document->createElementNS(self::MRSS_NS, 'content');
$entry->appendChild($entryEnclosure);
$entryEnclosure->setAttribute('url', $enclosure);
$entryEnclosure->setAttribute('type', getMimeType($enclosure));
$entry->appendChild($entryEnclosure);
}

$entryCategories = '';
foreach($item->getCategories() as $category) {
$entryCategory = $document->createElement('category');
$entryCategory->appendChild($document->createTextNode($category));
$entry->appendChild($entryCategory);
$entryCategory->appendChild($document->createTextNode($category));
}

$channel->appendChild($entry);
}

$toReturn = $document->saveXML();
Expand Down

0 comments on commit 1af6cbe

Please sign in to comment.