composer require bayareawebpro/laravel-dom-pipelinehttps://packagist.org/packages/bayareawebpro/laravel-dom-pipeline
Laravel DOM Pipeline allows you to pipe HTML content through a series of classes
which can be helpful with sanitization and server-side enhancement / modification of page
elements. The pipeline will not return the <body> tag or any other tags outside of the
body scope.
"libxml_use_internal_errors" is enabled allow any type of tag to operated on. See DomPipelineService::class (line 25).
use BayAreaWebPro\DomPipeline\DomPipeline;
use My\Pipes\{
LazyLoadImageTags,
LazyLoadVideoTags,
BuildTableOfContents
};
$modified = DomPipeline::make($html, [
LazyLoadImageTags::class,
LazyLoadVideoTags::class,
BuildTableOfContents::class,
]);use DOMDocument;
use DOMXPath;
use Closure;
class UpdateHeaders{
public function handle(DOMDocument $dom, Closure $next)
{
$xpath = new DOMXPath($dom);
foreach ($xpath->query('//h1|//h2|//h3|//h4|//h5|//h6') as $node) {
// Change the header tags content.
$node->nodeValue = "This is a {$node->tagName} tag.";
}
return $next($dom);
}
}<?php declare(strict_types=1);
namespace App\Services\Html\Formatters;
use Closure;
use DOMElement;
use DOMDocument;
class LazyLoadImages
{
/**
* @param DOMDocument $dom
* @param Closure $next
* @return mixed
*/
public function handle(DOMDocument $dom, Closure $next)
{
foreach ($dom->getElementsByTagName('img') as $node) {
$this->lazyLoad($node);
}
return $next($dom);
}
/**
* @param DOMDocument $dom
* @param DOMElement $node
*/
protected function lazyLoad(DOMElement $node): void
{
if (!$node->hasAttribute('data-src')) {
// Set the data-src attribute.
$node->setAttribute('data-src', $node->getAttribute('src'));
// Set the src attribute to loading image.
$node->setAttribute('src', asset('images/loading.gif'));
// Merge the lazy load class into the class list.
$node->setAttribute('class',join(' ', [
$node->getAttribute('class'),
'lazy-load'
]));
}
}
}Convert an Iframe into a Vue Component extracting the video ID from the URL.
<?php declare(strict_types=1);
namespace App\Services\Html\Formatters;
use Closure;
use DOMElement;
use DOMDocument;
class LazyLoadVideos
{
/**
* @param DOMDocument $dom
* @param Closure $next
* @return mixed
*/
public function handle(DOMDocument $dom, Closure $next)
{
$xpath = new \DOMXPath($dom);
foreach($xpath->query('//iframe[@class="media"]') as $node){
$this->lazyLoad($dom, $node);
}
return $next($dom);
}
/**
* @param DOMDocument $dom
* @param DOMElement $node
*/
protected function lazyLoad(DOMDocument $dom, DOMElement $node): void
{
if(is_null($node->parentNode)) return;
// Match the YouTube Video ID.
// https://stackoverflow.com/questions/2936467/parse-youtube-video-id-using-preg-match
preg_match('%(?:youtube(?:-nocookie)?\.com/(?:[^/]+/.+/|(?:v|e(?:mbed)?)/|.*[?&]v=)|youtu\.be/)([^"&?/ ]{11})%i',
(string) $node->getAttribute('src'), $matches
);
if(isset($matches[1])){
// Create a new HTML fragment.
$fragment = $dom->createDocumentFragment();
$fragment->appendXML(<<<HTML
<v-video id="$matches[1]" label="Click to play..." :show-image="true"></v-video>
HTML);
// Replace Self with Fragment.
$node->parentNode->replaceChild($fragment, $node);
}
}
}<?php declare(strict_types=1);
namespace App\Services\Html\Formatters;
use DOMElement;
use Closure;
use StdClass;
use DOMDocument;
use Illuminate\Support\Str;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\View;
class TableOfContents
{
/**
* @param DOMDocument $dom
* @param Closure $next
* @return mixed
*/
public function handle(DOMDocument $dom, Closure $next)
{
$nodes = Collection::make();
$xpath = new \DOMXPath($dom);
foreach ($xpath->query('//h1|//h2|//h3|//h4|//h5|//h6') as $node) {
$text = strip_tags(html_entity_decode((string) $node->nodeValue));
$nodes->push($this->makeBookmark($node, $text));
}
if($nodes->count() > 5){
View::share('tableOfContents', $nodes->take(25));
}
return $next($dom);
}
/**
* @param DOMElement $node
* @param string $text
* @return StdClass
*/
protected function makeBookmark(DOMElement $node, string $text): StdClass
{
// Create the bookmark item.
$bookmark = (object)[
'anchor' => Str::slug($text),
'text' => Str::title(Str::replaceLast('.', '', $text)),
];
// Link the bookmark to the header using the ID.
$node->setAttribute('id', $bookmark->anchor);
return $bookmark;
}
}Convert tables to bootstrap equivalent style.
<?php declare(strict_types=1);
namespace App\Services\Html\Formatters;
use Closure;
use DOMElement;
use DOMDocument;
class Tables
{
/**
* @param DOMDocument $dom
* @param \Closure $next
* @return mixed
*/
public function handle(DOMDocument $dom, Closure $next)
{
$xpath = new \DOMXPath($dom);
foreach($xpath->query('//table') as $node){
$this->makeResponsive($dom, $node);
}
return $next($dom);
}
/**
* Wrap Responsive
* @param DOMDocument $dom
* @param DOMElement $node
*/
protected function makeResponsive(DOMDocument $dom, DOMElement $node): void
{
if(is_null($node->parentNode)) return;
// Create the wrapper element.
$div = $dom->createElement('div');
// Apply classes to the element.
$div->setAttribute('class','table table-responsive table-striped table-hover');
// Clone and append the table to the element.
$div->appendChild($node->cloneNode(true));
// Swap the table for the new wrapped version.
$node->parentNode->replaceChild($div,$node);
}
}<?php declare(strict_types=1);
namespace App\Services\Html\Sanitizers;
use Illuminate\Support\Str;
use DOMDocument;
use DOMElement;
use Closure;
class Links
{
protected array $internalHosts = [
'//site.com',
'//www.site.com',
'//www.site.test',
'//staging.site.com',
];
protected array $protocols = [
"https://",
"http://",
"//",
];
protected array $mailable = [
"@username",
"mailto:",
];
protected array $blackList = [
"target",
"rel",
];
protected array $invalid = [
'#',
];
public function handle(DOMDocument $dom, Closure $next)
{
foreach($dom->getElementsByTagName('a') as $node){
$this->removeBlacklistedAttributes($node);
if ($this->isInvalidNode($node)) {
$this->unwrapNode($node);
} elseif ($this->isTelLink($node)) {
$this->formatTelLink($node);
} elseif ($this->isMailable($node)) {
$this->formatMailable($node);
} elseif ($this->isExternal($node)) {
$this->formatExternalLink($node);
} elseif ($this->isHomePage($node)) {
$this->formatHomepage($node);
} else {
$this->formatInternalLink($node);
}
}
return $next($dom);
}
protected function formatExternalLink(DOMElement $node): void
{
$node->setAttribute('target', '_blank');
$node->setAttribute('title', $this->makeTitleFromHost($node->getAttribute('href')));
$node->setAttribute('href', $this->fixProtocol($node->getAttribute('href')));
}
protected function formatMailable(DOMElement $node): void
{
if(!$node->hasAttribute('title')){
$email = $this->condenseValue(
str_replace('mailto:', '', (string)$node->getAttribute('href'))
);
$node->setAttribute('title', "Send an Email to {$email}");
}
}
protected function formatHomepage(DOMElement $node): void
{
$node->setAttribute('href', "/");
$node->setAttribute('title', config('app.name'));
}
protected function formatInternalLink(DOMElement $node): void
{
$slug = $this->toLowerCaseSlug($node->getAttribute('href'));
$node->setAttribute('href', "/$slug");
if (!$node->hasAttribute('title')) {
$node->setAttribute('title',
$this->makeTitleFromUrl($node->getAttribute('href'))
);
}
}
protected function formatTelLink(DOMElement $node): void
{
$formatted = $this->filterNumeric($node->getAttribute('href'));
if (empty($formatted)) {
$this->unwrapNode($node);
return;
}
if(!Str::startsWith($formatted, ['+'])){
$formatted = "+$formatted";
}
$node->setAttribute('href', "tel:{$formatted}");
if (!$node->hasAttribute('title')) {
$node->setAttribute('title', "Call {$formatted}");
}
}
protected function unwrapNode(DOMElement $node): void
{
$node->nodeValue = strip_tags($node->nodeValue);
}
protected function removeBlacklistedAttributes(DOMElement $node): void
{
foreach ($this->blackList as $attribute) {
$node->removeAttribute($attribute);
}
}
protected function isInvalidNode(DOMElement $node): bool
{
$href = $node->getAttribute('href');
return empty($href) || in_array($this->condenseValue($href), $this->invalid);
}
protected function condenseValue($value): string
{
return trim((string)$value);
}
protected function isTelLink(DOMElement $node): bool
{
return Str::startsWith($this->condenseValue($node->getAttribute('href')), ['tel:', '+']);
}
protected function isExternal(DOMElement $node): bool
{
return !Str::contains($node->getAttribute('href'), $this->internalHosts) &&
Str::startsWith($node->getAttribute('href'), $this->protocols);
}
protected function isMailable(DOMElement $node): bool
{
return Str::contains($node->getAttribute('href'), $this->mailable);
}
protected function isHomePage(DOMElement $node): bool
{
return (
in_array($this->condenseValue($node->getAttribute('href')), ['/']) ||
in_array(trim((string)$node->getAttribute('title')), [config('app.name')]) ||
Str::contains((string)$node->getAttribute('href'), $this->internalHosts)
);
}
protected function safelyParsePath($original): string
{
return (string)parse_url((string)$original, PHP_URL_PATH);
}
protected function safelyParseHost($original): string
{
return (string)parse_url((string)$original, PHP_URL_HOST);
}
protected function toLowerCaseSlug($url): string
{
return str_replace('_', '-',
Str::lower(trim($this->safelyParsePath($url), '/'))
);
}
protected function hasInvalidProtocol($url): bool
{
return Str::startsWith((string)$url, ['//']);
}
protected function fixProtocol($url): string
{
if ($this->hasInvalidProtocol($url)) {
return "http:$url";
}
return $url;
}
protected function makeTitleFromUrl($url): string
{
return trim(Str::title($this->filterAlphaNumeric($url)));
}
protected function filterAlphaNumeric($url){
return preg_replace('/[^a-zA-Z0-9]/', ' ', (string)$url);
}
protected function filterNumeric($url){
return preg_replace('/[^0-9-+]/', '', (string)$url);
}
protected function makeTitleFromHost($url): string
{
return "Visit {$this->safelyParseHost($url)}";
}
}