RssResponseRelativeUrlFilter.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/EventSubscriber/RssResponseRelativeUrlFilter.php
  2. 10 core/lib/Drupal/Core/EventSubscriber/RssResponseRelativeUrlFilter.php
  3. 11.x core/lib/Drupal/Core/EventSubscriber/RssResponseRelativeUrlFilter.php

Namespace

Drupal\Core\EventSubscriber

File

core/lib/Drupal/Core/EventSubscriber/RssResponseRelativeUrlFilter.php

View source
<?php

namespace Drupal\Core\EventSubscriber;

use Drupal\Component\Utility\Html;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

/**
 * Subscribes to filter RSS responses, to make relative URIs absolute.
 */
class RssResponseRelativeUrlFilter implements EventSubscriberInterface {
    
    /**
     * Converts relative URLs to absolute URLs.
     *
     * @param \Symfony\Component\HttpKernel\Event\ResponseEvent $event
     *   The response event.
     */
    public function onResponse(ResponseEvent $event) {
        // Only care about RSS responses.
        if (stripos($event->getResponse()->headers
            ->get('Content-Type', ''), 'application/rss+xml') === FALSE) {
            return;
        }
        $response = $event->getResponse();
        $response->setContent($this->transformRootRelativeUrlsToAbsolute($response->getContent(), $event->getRequest()));
    }
    
    /**
     * Converts all root-relative URLs to absolute URLs in RSS markup.
     *
     * Does not change any existing protocol-relative or absolute URLs.
     *
     * @param string $rss_markup
     *   The RSS markup to update.
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request.
     *
     * @return string
     *   The updated RSS markup.
     */
    protected function transformRootRelativeUrlsToAbsolute($rss_markup, Request $request) {
        $rss_dom = new \DOMDocument();
        // Load the RSS, if there are parsing errors, abort and return the unchanged
        // markup.
        $previous_value = libxml_use_internal_errors(TRUE);
        $rss_dom->loadXML($rss_markup);
        $errors = libxml_get_errors();
        libxml_use_internal_errors($previous_value);
        if ($errors) {
            return $rss_markup;
        }
        // Invoke Html::transformRootRelativeUrlsToAbsolute() on all HTML content
        // embedded in this RSS feed.
        foreach ($rss_dom->getElementsByTagName('description') as $node) {
            $html_markup = $node->nodeValue;
            if (!empty($html_markup)) {
                $node->nodeValue = Html::transformRootRelativeUrlsToAbsolute($html_markup, $request->getSchemeAndHttpHost());
            }
        }
        return $rss_dom->saveXML();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() {
        // Should run after any other response subscriber that modifies the markup.
        // @see \Drupal\Core\EventSubscriber\ActiveLinkResponseFilter
        $events[KernelEvents::RESPONSE][] = [
            'onResponse',
            -512,
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
RssResponseRelativeUrlFilter Subscribes to filter RSS responses, to make relative URIs absolute.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.