2017 © Pedro Peláez
 

package purifier

Laravel 5 HtmlPurifier Package

image

mews/purifier

Laravel 5 HtmlPurifier Package

  • Wednesday, March 21, 2018
  • by mewebstudio
  • Repository
  • 39 Watchers
  • 873 Stars
  • 878,636 Installations
  • PHP
  • 53 Dependents
  • 0 Suggesters
  • 105 Forks
  • 26 Open issues
  • 15 Versions
  • 11 % Grown

The README.md

HTMLPurifier for Laravel 5/6/7/8/9/10/11

Build Status codecov Latest Stable Version Latest Unstable Version License Total Downloads, (*1)

A simple Laravel service provider for easily using HTMLPurifier inside Laravel. From their website:, (*2)

HTML Purifier is a standards-compliant HTML filter library written in PHP. HTML Purifier will not only remove all malicious code (better known as XSS) with a thoroughly audited, secure yet permissive whitelist, it will also make sure your documents are standards compliant, something only achievable with a comprehensive knowledge of W3C's specifications. Tired of using BBCode due to the current landscape of deficient or insecure HTML filters? Have a WYSIWYG editor but never been able to use it? Looking for high-quality, standards-compliant, open-source components for that application you're building? HTML Purifier is for you!, (*3)

Installation

For Laravel 5.5+

Require this package with composer:, (*4)

composer require mews/purifier

The service provider will be auto-discovered. You do not need to add the provider anywhere., (*5)

For Laravel 5.0 to 5.4

Require this package with composer:, (*6)

composer require mews/purifier

Find the providers key in config/app.php and register the HTMLPurifier Service Provider., (*7)

    'providers' => [
        // ...
        Mews\Purifier\PurifierServiceProvider::class,
    ]

Find the aliases key in config/app.php and register the Purifier alias., (*8)

    'aliases' => [
        // ...
        'Purifier' => Mews\Purifier\Facades\Purifier::class,
    ]

For Laravel 4

Check out HTMLPurifier for Laravel 4, (*9)

Usage

Use these methods inside your requests or middleware, wherever you need the HTML cleaned up:, (*10)

clean(Input::get('inputname'));

or, (*11)

Purifier::clean(Input::get('inputname'));

dynamic config, (*12)

clean('This is my H1 title', 'titles');
clean('This is my H1 title', array('Attr.EnableID' => true));

or, (*13)

Purifier::clean('This is my H1 title', 'titles');
Purifier::clean('This is my H1 title', array('Attr.EnableID' => true));

use URI filter, (*14)

Purifier::clean('This is my H1 title', 'titles', function (HTMLPurifier_Config $config) {
    $uri = $config->getDefinition('URI');
    $uri->addFilter(new HTMLPurifier_URIFilter_NameOfFilter(), $config);
});

Alternatively, in Laravel 7+, if you're looking to clean your HTML inside your Eloquent models, you can use our custom casts:, (*15)

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Mews\Purifier\Casts\CleanHtml;
use Mews\Purifier\Casts\CleanHtmlInput;
use Mews\Purifier\Casts\CleanHtmlOutput;

class Monster extends Model
{
    protected $casts = [
        'bio'            => CleanHtml::class, // cleans both when getting and setting the value
        'description'    => CleanHtmlInput::class, // cleans when setting the value
        'history'        => CleanHtmlOutput::class, // cleans when getting the value
    ];
}

Configuration

To use your own settings, publish config., (*16)

php artisan vendor:publish --provider="Mews\Purifier\PurifierServiceProvider"

Config file config/purifier.php should like this, (*17)


return [
    'encoding'           => 'UTF-8',
    'finalize'           => true,
    'ignoreNonStrings'   => false,
    'cachePath'          => storage_path('app/purifier'),
    'cacheFileMode'      => 0755,
    'settings'      => [
        'default' => [
            'HTML.Doctype'             => 'HTML 4.01 Transitional',
            'HTML.Allowed'             => 'div,b,strong,i,em,u,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
            'CSS.AllowedProperties'    => 'font,font-size,font-weight,font-style,font-family,text-decoration,padding-left,color,background-color,text-align',
            'AutoFormat.AutoParagraph' => true,
            'AutoFormat.RemoveEmpty'   => true,
        ],
        'test'    => [
            'Attr.EnableID' => 'true',
        ],
        "youtube" => [
            "HTML.SafeIframe"      => 'true',
            "URI.SafeIframeRegexp" => "%^(http://|https://|//)(www.youtube.com/embed/|player.vimeo.com/video/)%",
        ],
        'custom_definition' => [
            'id'  => 'html5-definitions',
            'rev' => 1,
            'debug' => false,
            'elements' => [
                // http://developers.whatwg.org/sections.html
                ['section', 'Block', 'Flow', 'Common'],
                ['nav',     'Block', 'Flow', 'Common'],
                ['article', 'Block', 'Flow', 'Common'],
                ['aside',   'Block', 'Flow', 'Common'],
                ['header',  'Block', 'Flow', 'Common'],
                ['footer',  'Block', 'Flow', 'Common'],

                // Content model actually excludes several tags, not modelled here
                ['address', 'Block', 'Flow', 'Common'],
                ['hgroup', 'Block', 'Required: h1 | h2 | h3 | h4 | h5 | h6', 'Common'],

                // http://developers.whatwg.org/grouping-content.html
                ['figure', 'Block', 'Optional: (figcaption, Flow) | (Flow, figcaption) | Flow', 'Common'],
                ['figcaption', 'Inline', 'Flow', 'Common'],

                // http://developers.whatwg.org/the-video-element.html#the-video-element
                ['video', 'Block', 'Optional: (source, Flow) | (Flow, source) | Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                    'width' => 'Length',
                    'height' => 'Length',
                    'poster' => 'URI',
                    'preload' => 'Enum#auto,metadata,none',
                    'controls' => 'Bool',
                ]],
                ['source', 'Block', 'Flow', 'Common', [
                    'src' => 'URI',
                    'type' => 'Text',
                ]],

                // http://developers.whatwg.org/text-level-semantics.html
                ['s',    'Inline', 'Inline', 'Common'],
                ['var',  'Inline', 'Inline', 'Common'],
                ['sub',  'Inline', 'Inline', 'Common'],
                ['sup',  'Inline', 'Inline', 'Common'],
                ['mark', 'Inline', 'Inline', 'Common'],
                ['wbr',  'Inline', 'Empty', 'Core'],

                // http://developers.whatwg.org/edits.html
                ['ins', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
                ['del', 'Block', 'Flow', 'Common', ['cite' => 'URI', 'datetime' => 'CDATA']],
            ],
            'attributes' => [
                ['iframe', 'allowfullscreen', 'Bool'],
                ['table', 'height', 'Text'],
                ['td', 'border', 'Text'],
                ['th', 'border', 'Text'],
                ['tr', 'width', 'Text'],
                ['tr', 'height', 'Text'],
                ['tr', 'border', 'Text'],
            ],
        ],
        'custom_attributes' => [
            ['a', 'target', 'Enum#_blank,_self,_target,_top'],
        ],
        'custom_elements' => [
            ['u', 'Inline', 'Inline', 'Common'],
        ],
    ],

];

Change log

Please see the Github Releases Tab for more information on what has changed recently., (*18)

Security

If you discover any security related issues, please email the author instead of using the issue tracker., (*19)

Credits

License

MIT. Please see the license file for more information., (*20)

The Versions

21/03 2018

dev-master

9999999-dev https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

21/03 2018

2.1.0

2.1.0.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

11/09 2017

2.0.9

2.0.9.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

08/08 2017

v2.0.8

2.0.8.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

16/04 2017

v2.0.7

2.0.7.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

27/07 2016

2.0.6

2.0.6.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

03/06 2016

dev-master-l4

dev-master-l4 http://github.com/mewebstudio/Purifier

HTMLPurifier Package for Laravel 4

  Sources   Download

LGPL

The Requires

 

by Muharrem ERIN

laravel laravel 4 purifier l4 htmlpurifier

26/04 2016

2.0.5

2.0.5.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

02/02 2016

2.0.4

2.0.4.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

31/08 2015

2.0.3

2.0.3.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

28/08 2015

2.0.2

2.0.2.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

29/07 2015

2.0.1

2.0.1.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

11/04 2015

2.0.0

2.0.0.0 https://github.com/mewebstudio/purifier

Laravel 5 HtmlPurifier Package

  Sources   Download

MIT

The Requires

 

The Development Requires

by Muharrem ERIN

security xss purifier laravel5 security htmlpurifier laravel5 htmlpurifier laravel5 purifier

31/12 2014

1.0.2

1.0.2.0 http://github.com/mewebstudio/Purifier

HTMLPurifier Package for Laravel 4

  Sources   Download

LGPL

The Requires

 

by Muharrem ERIN

laravel laravel 4 purifier l4 htmlpurifier

25/01 2014

1.0.1

1.0.1.0 http://github.com/mewebstudio/Purifier

HTMLPurifier Package for Laravel 4

  Sources   Download

LGPL

The Requires

 

by Muharrem ERIN

laravel laravel 4 purifier l4 htmlpurifier