mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-12 09:44:38 +02:00
Code Issues Releases Wiki Activity

Add feature request processwire/processwire-requests#226 for additional HTML purifier configuration options

Browse Source
This commit is contained in:
Ryan Cramer
2021-02-12 11:24:11 -05:00
parent c414a54531
commit 990041adb9
1 changed files with 66 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
wire/modules/Markup/MarkupHTMLPurifier/MarkupHTMLPurifier.module
View File

@@ -23,6 +23,8 @@
* HTML Purifier by: http://htmlpurifier.org * HTML Purifier by: http://htmlpurifier.org
* ProcessWire module by Ryan Cramer * ProcessWire module by Ryan Cramer
* *
* @method void initConfig(\HTMLPurifier_Config $settings, \HTMLPurifier_HTMLDefinition $def)
*
*/ */
class MarkupHTMLPurifier extends WireData implements Module { class MarkupHTMLPurifier extends WireData implements Module {
@@ -31,7 +33,7 @@ class MarkupHTMLPurifier extends WireData implements Module {
return array( return array(
'title' => 'HTML Purifier', 'title' => 'HTML Purifier',
'summary' => 'Front-end to the HTML Purifier library.', 'summary' => 'Front-end to the HTML Purifier library.',
'version' => 495, 'version' => 496,
'singular' => false, 'singular' => false,
'autoload' => false, 'autoload' => false,
); );
@@ -40,9 +42,19 @@ class MarkupHTMLPurifier extends WireData implements Module {
/** /**
* HTML Purifier settings * HTML Purifier settings
* *
* @var \HTMLPurifier_Config|null
*
*/ */
protected $settings = null; protected $settings = null;
/**
* HTML Purifier Raw HTML definition
*
* @var \HTMLPurifier_HTMLDefinition|null
*
*/
protected $def = null;
/** /**
* Cached instance of HTMLPurifier * Cached instance of HTMLPurifier
* *
@@ -68,32 +80,76 @@ class MarkupHTMLPurifier extends WireData implements Module {
$this->settings->set('Attr.AllowedRel', array('nofollow')); $this->settings->set('Attr.AllowedRel', array('nofollow'));
$this->settings->set('HTML.DefinitionID', 'html5-definitions'); $this->settings->set('HTML.DefinitionID', 'html5-definitions');
$this->settings->set('HTML.DefinitionRev', 1); $this->settings->set('HTML.DefinitionRev', 1);
if($def = $this->settings->maybeGetRawHTMLDefinition()) { $this->def = $this->settings->maybeGetRawHTMLDefinition();
$def->addElement('figure', 'Block', 'Optional: (figcaption, Flow) | (Flow, figcaption) | Flow', 'Common'); if($this->def) {
$def->addElement('figcaption', 'Inline', 'Flow', 'Common'); $this->def->addElement('figure', 'Block', 'Optional: (figcaption, Flow) | (Flow, figcaption) | Flow', 'Common');
$this->def->addElement('figcaption', 'Inline', 'Flow', 'Common');
$this->initConfig($this->settings, $this->def);
} }
} }
/** /**
* Return the cache path used by HTML Purifier * Method to allow hooks to further initialize HTMLPurifier config/settings
*
* ~~~~~
* $wire->addHook('MarkupHTMLPurifier::initSettings', function($event) {
* $def = $event->arguments(1);
* $def->addAttribute('a', 'data-ext', 'Text');
* });
* ~~~~~
*
* @param \HTMLPurifier_Config $settings
* @param \HTMLPurifier_HTMLDefinition $def
* @since 3.0.173
* *
*/ */
protected function getCachePath() { protected function ___initConfig($settings, $def) { }
$cachePath = $this->wire('config')->paths->cache . $this->className() . '/';
if(!is_dir($cachePath)) $this->wire('files')->mkdir($cachePath); /**
* Return the cache path used by HTML Purifier
*
* @param bool $create Create if not exists?
* @return string
*
*/
protected function getCachePath($create = true) {
$cachePath = $this->wire()->config->paths->cache . $this->className() . '/';
if($create && !is_dir($cachePath)) $this->wire()->files->mkdir($cachePath);
return $cachePath; return $cachePath;
} }
/**
* Clear the HTML Purifier cache
*
* @since 3.0.173
*
*/
public function clearCache() {
$cachePath = $this->getCachePath(false);
if(is_dir($cachePath)) $this->wire()->files->rmdir($cachePath, true);
}
/** /**
* Return the current settings * Return the current settings
* *
* @return \HTMLPurifier_Config * @return \HTMLPurifier_Config|null
* *
*/ */
public function getConfig() { public function getConfig() {
return $this->settings; return $this->settings;
} }
/**
* Get HTML Purifier raw HTML definition
*
* @return \HTMLPurifier_HTMLDefinition|null
* @since 3.0.173
*
*/
public function getDef() {
return $this->def;
}
/** /**
* Get the HTMLPurifier instance * Get the HTMLPurifier instance
* *