Skip to content
This repository was archived by the owner on Mar 5, 2022. It is now read-only.

Commit 57aab85

Browse files
author
Florian Krämer
committed
Improving the shell and documentation.
1 parent 4238217 commit 57aab85

File tree

12 files changed

+323
-205
lines changed

12 files changed

+323
-205
lines changed

‎.editorconfig‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
indent_style = spaces
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
charset = utf-8
12+
13+
[*.js]
14+
indent_style = tabs
15+
indent_size = 4
16+
17+
[*.css]
18+
indent_style = tabs
19+
indent_size = 4
20+
21+
[*.bat]
22+
indent_style = tabs
23+
indent_size = 4
24+
end_of_line = crlf
25+
26+
[*.yml]
27+
indent_style = tabs
28+
indent_size = 4

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
CakePHP HTML Purifier Plugin
22
----------------------------
33

4-
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)
5-
[![Build Status](https://img.shields.io/travis/burzum/cakephp-html-purifier/master.svg?style=flat-square)](https://travis-ci.org/burzum/cakephp-html-purifier)
4+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)
5+
[![Build Status](https://img.shields.io/travis/burzum/cakephp-html-purifier/master.svg?style=flat-square)](https://travis-ci.org/burzum/cakephp-html-purifier)
66
[![Build Status](https://img.shields.io/coveralls/burzum/cakephp-html-purifier/master.svg?style=flat-square)](https://coveralls.io/r/burzum/cakephp-html-purifier)
77

8-
This is a CakePHP wrapper for the HTML Purifier lib. http://htmlpurifier.org/
8+
This is a CakePHP wrapper for [the HTML Purifier lib](http://htmlpurifier.org/).
99

1010
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.
1111

12-
The plugin includes a Helper and Behavior to clean your markup wherever you like, in the view or in Model::beforeSave.
12+
The plugin includes a trait, a view helper, a behavior and a shell to clean your markup wherever you like, in the view or in the model layer or clean any table and field using the shell.
1313

1414
---
1515

@@ -43,6 +43,6 @@ Please feel free to contribute to the plugin with new issues, requests, unit tes
4343
License
4444
-------
4545

46-
Copyright 2013 - 2015 Florian Krämer
46+
Copyright 2012 - 2016 Florian Krämer
4747

4848
Licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.

‎docs/Configuration.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Configuration
2+
3+
## Purifier Filter Configuration
4+
5+
Important: Before you start declaring a configuration you should lookup how HTML Purifier can be configured. http://htmlpurifier.org/docs
6+
7+
In `config/boostrap.php` you can either set the purifier config as an array or pass a native config object.
8+
9+
The array style would look like this:
10+
11+
```php
12+
Purifier::config('ConfigName', array(
13+
'HTML.AllowedElements' => 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img',
14+
'HTML.AllowedAttributes' => 'a.href, a.title, img.src, img.alt'
15+
)
16+
);
17+
```
18+
19+
The plugin will construct a HTML Purifier config from that and instantiate the purifier.
20+
21+
A pure HTML Purifier config might look like this one:
22+
23+
```php
24+
$config = HTMLPurifier_Config::createDefault();
25+
$config->set('HTML.AllowedElements', 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img');
26+
$config->set('HTML.AllowedAttributes', 'a.href, a.title, img.src, img.alt');
27+
$config->set('HTML.AllowedAttributes', "*.style");
28+
$config->set('CSS.AllowedProperties', 'text-decoration');
29+
$config->set('HTML.TidyLevel', 'heavy');
30+
$config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
31+
```
32+
33+
Simply assign it to a config:
34+
35+
```php
36+
Purifier::config('ConfigName', $config);
37+
```
38+
39+
Now that you have a configured instance of HTML Purifier ready you can use it directly and get you an instance of the purifier
40+
41+
```php
42+
Purifier::config('ConfigName');
43+
```
44+
45+
or clean some dirty HTML directly by calling
46+
47+
```php
48+
Purifier::clean($markup, 'ConfigName');
49+
```
50+
51+
For some automatization you can also use the Behavior or Helper.
52+
53+
## Caching ###
54+
55+
It is recommended to change the path of the purifier libs cache to your `tmp` folder. For example:
56+
57+
```php
58+
Purifier::config('ConfigName', array(
59+
'Cache.SerializerPath' => ROOT . DS . 'tmp' . DS . 'purifier',
60+
)
61+
);
62+
```
63+
64+
See this page as well [http://htmlpurifier.org/live/configdoc/plain.html#Cache](http://htmlpurifier.org/live/configdoc/plain.html#Cache).

‎docs/Home.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
CakePHP HTML Purifier Plugin
2+
----------------------------
3+
4+
This is a CakePHP wrapper for [the HTML Purifier lib](http://htmlpurifier.org/).
5+
6+
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.
7+
8+
The plugin includes a trait, a view helper, a behavior and a shell to clean your markup wherever you like, in the view or in the model layer or clean any table and field using the shell.
9+
10+
* [Installation](Installation.md)
11+
* [Configuration](Configuration.md)
12+
* [Read this if you are using APC](If-you-are-using-APC.md)
13+
* [Usage](Usage.md)
14+
15+
License
16+
-------
17+
18+
Copyright 2012 - 2016 Florian Krämer
19+
20+
Licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.

‎docs/If-you-are-using-APC.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# If you are using APC ...
2+
3+
...and get this error message
4+
5+
Fatal error: Cannot override final method HTMLPurifier_VarParser::parse()
6+
7+
you can fix this by adding
8+
9+
```php
10+
Configure::write('HtmlPurifier.standalone', true);
11+
```
12+
13+
to your bootstrap.php *before* you load this plugin.
14+
15+
This line will use a compacted one file version of Html Purifier. This is an official and know issue and workaround, see http://htmlpurifier.org/phorum/read.php?3,4099,6680.

‎docs/Usage.md‎

Lines changed: 23 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,6 @@
1-
Usage
2-
=====
1+
# Usage
32

4-
If you use APC ...
5-
------------------
6-
7-
...and get this error message
8-
9-
Fatal error: Cannot override final method HTMLPurifier_VarParser::parse()
10-
11-
you can fix this by adding
12-
13-
```php
14-
Configure::write('HtmlPurifier.standalone', true);
15-
```
16-
17-
to your bootstrap.php *before* you load this plugin.
18-
19-
This line will use a compacted one file version of Html Purifier. This is an official and know issue and workaround, see http://htmlpurifier.org/phorum/read.php?3,4099,6680.
20-
21-
Configuration
22-
-------------
23-
24-
Important: Before you start declaring a configuration you should lookup how HTML Purifier can be configured. http://htmlpurifier.org/docs
25-
26-
In `config/boostrap.php` you can either set the purifier config as an array or pass a native config object.
27-
28-
The array style would look like this:
29-
30-
```php
31-
Purifier::config('ConfigName', array(
32-
'HTML.AllowedElements' => 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img',
33-
'HTML.AllowedAttributes' => 'a.href, a.title, img.src, img.alt'
34-
)
35-
);
36-
```
37-
38-
The plugin will construct a HTML Purifier config from that and instantiate the purifier.
39-
40-
A pure HTML Purifier config might look like this one:
41-
42-
```php
43-
$config = HTMLPurifier_Config::createDefault();
44-
$config->set('HTML.AllowedElements', 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img');
45-
$config->set('HTML.AllowedAttributes', 'a.href, a.title, img.src, img.alt');
46-
$config->set('HTML.AllowedAttributes', "*.style");
47-
$config->set('CSS.AllowedProperties', 'text-decoration');
48-
$config->set('HTML.TidyLevel', 'heavy');
49-
$config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
50-
```
51-
52-
Simply assign it to a config:
53-
54-
```php
55-
Purifier::config('ConfigName', $config);
56-
```
57-
58-
Now that you have a configured instance of HTML Purifier ready you can use it directly and get you an instance of the purifier
59-
60-
```php
61-
Purifier::config('ConfigName');
62-
```
63-
64-
or clean some dirty HTML directly by calling
65-
66-
```php
67-
Purifier::clean($markup, 'ConfigName');
68-
```
69-
70-
For some automatization you can also use the Behavior or Helper.
71-
72-
### Caching ###
73-
74-
It is recommended to change the path of the purifier libs cache to your `tmp` folder. For example:
75-
76-
```php
77-
Purifier::config('ConfigName', array(
78-
'Cache.SerializerPath' => ROOT . DS . 'tmp' . DS . 'purifier',
79-
)
80-
);
81-
```
82-
83-
See this page as well http://htmlpurifier.org/live/configdoc/plain.html#Cache.
84-
85-
### The Behavior
3+
## The Behavior
864

875
Set a config you want to use and the fields you want to sanitize.
886

@@ -97,7 +15,7 @@ public $actsAs = array(
9715
);
9816
```
9917

100-
### The Helper
18+
## The Helper
10119

10220
In your controller load the helper and set a default config if you want.
10321

@@ -114,3 +32,23 @@ In the views you can then use the helper like this:
11432
```php
11533
$this->HtmlPurifier->clean($markup, 'ConfigName');
11634
```
35+
36+
## The Shell
37+
38+
Using the shell is very easy and self-explaining:
39+
40+
```sh
41+
cake purify <table> <fields>
42+
```
43+
44+
You can specify a purifier config to use as well:
45+
46+
```sh
47+
cake purify <table> <fields> --config myconfig
48+
```
49+
50+
## The Trait
51+
52+
Where ever you need the purifier you can simply add it to your class by using the [PurifierTrait](../src/Lib/PurifierTrait.php).
53+
54+
[See the official php documentation](http://php.net/manual/en/language.oop5.traits.php) for traits if you don't know how to use it.

‎src/Lib/Purifier.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Purifier
44
*
55
* @author Florian Krämer
6-
* @copyright 2012 - 2015 Florian Krämer
6+
* @copyright 2012 - 2016 Florian Krämer
77
* @license MIT
88
*/
99
namespace Burzum\HtmlPurifier\Lib;

‎src/Lib/PurifierTrait.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Purifier
44
*
55
* @author Florian Krämer
6-
* @copyright 2012 - 2015 Florian Krämer
6+
* @copyright 2012 - 2016 Florian Krämer
77
* @license MIT
88
*/
99
namespace Burzum\HtmlPurifier\Lib;

‎src/Model/Behavior/HtmlPurifierBehavior.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Purifier
44
*
55
* @author Florian Krämer
6-
* @copyright 2012 - 2015 Florian Krämer
6+
* @copyright 2012 - 2016 Florian Krämer
77
* @license MIT
88
*/
99
namespace Burzum\HtmlPurifier\Model\Behavior;

0 commit comments

Comments
 (0)