Merge pull request #481 from wallabag/dev1.5.2

1.5.2
author: Nicolas Lœuillet <nicolas@loeuillet.org> 2014-02-21 15:57:10 +0100
committer: Nicolas Lœuillet <nicolas@loeuillet.org> 2014-02-21 15:57:10 +0100
commit: 99679d06884120c57f43b44e55e03595f1f87bed (patch)
tree: a3f2a1aa1afdaeca1386d0c6e8a75344fd2241fb /inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php
parent: 655214ab30ee84884dc408488b85586f36263fcb (diff)
parent: d3b47e94705e17b3ba3529cbb1dc6efe69c5d2b7 (diff)
download: wallabag-1.5.2.tar.gz
wallabag-1.5.2.tar.zst
wallabag-1.5.2.zip
1 files changed, 230 insertions, 0 deletions
diff --git a/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php b/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php
new file mode 100644
index 00000000..f482a374
--- /dev/null
+++ b/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php
@@ -0,0 +1,230 @@
+<?php
+/**
+ * Abstract class for a set of proprietary modules that clean up (tidy)
+ * poorly written HTML.
+ * @todo Figure out how to protect some of these methods/properties
+ */
+class HTMLPurifier_HTMLModule_Tidy extends HTMLPurifier_HTMLModule
+{
+    /**
+     * List of supported levels.
+     * Index zero is a special case "no fixes" level.
+     * @type array
+     */
+    public $levels = array(0 => 'none', 'light', 'medium', 'heavy');
+    /**
+     * Default level to place all fixes in.
+     * Disabled by default.
+     * @type string
+     */
+    public $defaultLevel = null;
+    /**
+     * Lists of fixes used by getFixesForLevel().
+     * Format is:
+     *      HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2');
+     * @type array
+     */
+    public $fixesForLevel = array(
+        'light' => array(),
+        'medium' => array(),
+        'heavy' => array()
+    );
+    /**
+     * Lazy load constructs the module by determining the necessary
+     * fixes to create and then delegating to the populate() function.
+     * @param HTMLPurifier_Config $config
+     * @todo Wildcard matching and error reporting when an added or
+     *       subtracted fix has no effect.
+     */
+    public function setup($config)
+    {
+        // create fixes, initialize fixesForLevel
+        $fixes = $this->makeFixes();
+        $this->makeFixesForLevel($fixes);
+        // figure out which fixes to use
+        $level = $config->get('HTML.TidyLevel');
+        $fixes_lookup = $this->getFixesForLevel($level);
+        // get custom fix declarations: these need namespace processing
+        $add_fixes = $config->get('HTML.TidyAdd');
+        $remove_fixes = $config->get('HTML.TidyRemove');
+        foreach ($fixes as $name => $fix) {
+            // needs to be refactored a little to implement globbing
+            if (isset($remove_fixes[$name]) ||
+                (!isset($add_fixes[$name]) && !isset($fixes_lookup[$name]))) {
+                unset($fixes[$name]);
+            }
+        }
+        // populate this module with necessary fixes
+        $this->populate($fixes);
+    }
+    /**
+     * Retrieves all fixes per a level, returning fixes for that specific
+     * level as well as all levels below it.
+     * @param string $level level identifier, see $levels for valid values
+     * @return array Lookup up table of fixes
+     */
+    public function getFixesForLevel($level)
+    {
+        if ($level == $this->levels[0]) {
+            return array();
+        }
+        $activated_levels = array();
+        for ($i = 1, $c = count($this->levels); $i < $c; $i++) {
+            $activated_levels[] = $this->levels[$i];
+            if ($this->levels[$i] == $level) {
+                break;
+            }
+        }
+        if ($i == $c) {
+            trigger_error(
+                'Tidy level ' . htmlspecialchars($level) . ' not recognized',
+                E_USER_WARNING
+            );
+            return array();
+        }
+        $ret = array();
+        foreach ($activated_levels as $level) {
+            foreach ($this->fixesForLevel[$level] as $fix) {
+                $ret[$fix] = true;
+            }
+        }
+        return $ret;
+    }
+    /**
+     * Dynamically populates the $fixesForLevel member variable using
+     * the fixes array. It may be custom overloaded, used in conjunction
+     * with $defaultLevel, or not used at all.
+     * @param array $fixes
+     */
+    public function makeFixesForLevel($fixes)
+    {
+        if (!isset($this->defaultLevel)) {
+            return;
+        }
+        if (!isset($this->fixesForLevel[$this->defaultLevel])) {
+            trigger_error(
+                'Default level ' . $this->defaultLevel . ' does not exist',
+                E_USER_ERROR
+            );
+            return;
+        }
+        $this->fixesForLevel[$this->defaultLevel] = array_keys($fixes);
+    }
+    /**
+     * Populates the module with transforms and other special-case code
+     * based on a list of fixes passed to it
+     * @param array $fixes Lookup table of fixes to activate
+     */
+    public function populate($fixes)
+    {
+        foreach ($fixes as $name => $fix) {
+            // determine what the fix is for
+            list($type, $params) = $this->getFixType($name);
+            switch ($type) {
+                case 'attr_transform_pre':
+                case 'attr_transform_post':
+                    $attr = $params['attr'];
+                    if (isset($params['element'])) {
+                        $element = $params['element'];
+                        if (empty($this->info[$element])) {
+                            $e = $this->addBlankElement($element);
+                        } else {
+                            $e = $this->info[$element];
+                        }
+                    } else {
+                        $type = "info_$type";
+                        $e = $this;
+                    }
+                    // PHP does some weird parsing when I do
+                    // $e->$type[$attr], so I have to assign a ref.
+                    $f =& $e->$type;
+                    $f[$attr] = $fix;
+                    break;
+                case 'tag_transform':
+                    $this->info_tag_transform[$params['element']] = $fix;
+                    break;
+                case 'child':
+                case 'content_model_type':
+                    $element = $params['element'];
+                    if (empty($this->info[$element])) {
+                        $e = $this->addBlankElement($element);
+                    } else {
+                        $e = $this->info[$element];
+                    }
+                    $e->$type = $fix;
+                    break;
+                default:
+                    trigger_error("Fix type $type not supported", E_USER_ERROR);
+                    break;
+            }
+        }
+    }
+    /**
+     * Parses a fix name and determines what kind of fix it is, as well
+     * as other information defined by the fix
+     * @param $name String name of fix
+     * @return array(string $fix_type, array $fix_parameters)
+     * @note $fix_parameters is type dependant, see populate() for usage
+     *       of these parameters
+     */
+    public function getFixType($name)
+    {
+        // parse it
+        $property = $attr = null;
+        if (strpos($name, '#') !== false) {
+            list($name, $property) = explode('#', $name);
+        }
+        if (strpos($name, '@') !== false) {
+            list($name, $attr) = explode('@', $name);
+        }
+        // figure out the parameters
+        $params = array();
+        if ($name !== '') {
+            $params['element'] = $name;
+        }
+        if (!is_null($attr)) {
+            $params['attr'] = $attr;
+        }
+        // special case: attribute transform
+        if (!is_null($attr)) {
+            if (is_null($property)) {
+                $property = 'pre';
+            }
+            $type = 'attr_transform_' . $property;
+            return array($type, $params);
+        }
+        // special case: tag transform
+        if (is_null($property)) {
+            return array('tag_transform', $params);
+        }
+        return array($property, $params);
+    }
+    /**
+     * Defines all fixes the module will perform in a compact
+     * associative array of fix name to fix implementation.
+     * @return array
+     */
+    public function makeFixes()
+    {
+    }
+}
+// vim: et sw=4 sts=4
author	Nicolas Lœuillet <nicolas@loeuillet.org>	2014-02-21 15:57:10 +0100
committer	Nicolas Lœuillet <nicolas@loeuillet.org>	2014-02-21 15:57:10 +0100
commit	99679d06884120c57f43b44e55e03595f1f87bed (patch)
tree	a3f2a1aa1afdaeca1386d0c6e8a75344fd2241fb /inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php
parent	655214ab30ee84884dc408488b85586f36263fcb (diff)
parent	d3b47e94705e17b3ba3529cbb1dc6efe69c5d2b7 (diff)
download	wallabag-1.5.2.tar.gz wallabag-1.5.2.tar.zst wallabag-1.5.2.zip

diff --git a/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php b/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php new file mode 100644 index 00000000..f482a374 --- /dev/null +++ b/inc/3rdparty/htmlpurifier/HTMLPurifier/HTMLModule/Tidy.php
@@ -0,0 +1,230 @@
	1	<?php
	2
	3	/**
	4	* Abstract class for a set of proprietary modules that clean up (tidy)
	5	* poorly written HTML.
	6	* @todo Figure out how to protect some of these methods/properties
	7	*/
	8	class HTMLPurifier_HTMLModule_Tidy extends HTMLPurifier_HTMLModule
	9	{
	10	/**
	11	* List of supported levels.
	12	* Index zero is a special case "no fixes" level.
	13	* @type array
	14	*/
	15	public $levels = array(0 => 'none', 'light', 'medium', 'heavy');
	16
	17	/**
	18	* Default level to place all fixes in.
	19	* Disabled by default.
	20	* @type string
	21	*/
	22	public $defaultLevel = null;
	23
	24	/**
	25	* Lists of fixes used by getFixesForLevel().
	26	* Format is:
	27	* HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2');
	28	* @type array
	29	*/
	30	public $fixesForLevel = array(
	31	'light' => array(),
	32	'medium' => array(),
	33	'heavy' => array()
	34	);
	35
	36	/**
	37	* Lazy load constructs the module by determining the necessary
	38	* fixes to create and then delegating to the populate() function.
	39	* @param HTMLPurifier_Config $config
	40	* @todo Wildcard matching and error reporting when an added or
	41	* subtracted fix has no effect.
	42	*/
	43	public function setup($config)
	44	{
	45	// create fixes, initialize fixesForLevel
	46	$fixes = $this->makeFixes();
	47	$this->makeFixesForLevel($fixes);
	48
	49	// figure out which fixes to use
	50	$level = $config->get('HTML.TidyLevel');
	51	$fixes_lookup = $this->getFixesForLevel($level);
	52
	53	// get custom fix declarations: these need namespace processing
	54	$add_fixes = $config->get('HTML.TidyAdd');
	55	$remove_fixes = $config->get('HTML.TidyRemove');
	56
	57	foreach ($fixes as $name => $fix) {
	58	// needs to be refactored a little to implement globbing
	59	if (isset($remove_fixes[$name]) \|\|
	60	(!isset($add_fixes[$name]) && !isset($fixes_lookup[$name]))) {
	61	unset($fixes[$name]);
	62	}
	63	}
	64
	65	// populate this module with necessary fixes
	66	$this->populate($fixes);
	67	}
	68
	69	/**
	70	* Retrieves all fixes per a level, returning fixes for that specific
	71	* level as well as all levels below it.
	72	* @param string $level level identifier, see $levels for valid values
	73	* @return array Lookup up table of fixes
	74	*/
	75	public function getFixesForLevel($level)
	76	{
	77	if ($level == $this->levels[0]) {
	78	return array();
	79	}
	80	$activated_levels = array();
	81	for ($i = 1, $c = count($this->levels); $i < $c; $i++) {
	82	$activated_levels[] = $this->levels[$i];
	83	if ($this->levels[$i] == $level) {
	84	break;
	85	}
	86	}
	87	if ($i == $c) {
	88	trigger_error(
	89	'Tidy level ' . htmlspecialchars($level) . ' not recognized',
	90	E_USER_WARNING
	91	);
	92	return array();
	93	}
	94	$ret = array();
	95	foreach ($activated_levels as $level) {
	96	foreach ($this->fixesForLevel[$level] as $fix) {
	97	$ret[$fix] = true;
	98	}
	99	}
	100	return $ret;
	101	}
	102
	103	/**
	104	* Dynamically populates the $fixesForLevel member variable using
	105	* the fixes array. It may be custom overloaded, used in conjunction
	106	* with $defaultLevel, or not used at all.
	107	* @param array $fixes
	108	*/
	109	public function makeFixesForLevel($fixes)
	110	{
	111	if (!isset($this->defaultLevel)) {
	112	return;
	113	}
	114	if (!isset($this->fixesForLevel[$this->defaultLevel])) {
	115	trigger_error(
	116	'Default level ' . $this->defaultLevel . ' does not exist',
	117	E_USER_ERROR
	118	);
	119	return;
	120	}
	121	$this->fixesForLevel[$this->defaultLevel] = array_keys($fixes);
	122	}
	123
	124	/**
	125	* Populates the module with transforms and other special-case code
	126	* based on a list of fixes passed to it
	127	* @param array $fixes Lookup table of fixes to activate
	128	*/
	129	public function populate($fixes)
	130	{
	131	foreach ($fixes as $name => $fix) {
	132	// determine what the fix is for
	133	list($type, $params) = $this->getFixType($name);
	134	switch ($type) {
	135	case 'attr_transform_pre':
	136	case 'attr_transform_post':
	137	$attr = $params['attr'];
	138	if (isset($params['element'])) {
	139	$element = $params['element'];
	140	if (empty($this->info[$element])) {
	141	$e = $this->addBlankElement($element);
	142	} else {
	143	$e = $this->info[$element];
	144	}
	145	} else {
	146	$type = "info_$type";
	147	$e = $this;
	148	}
	149	// PHP does some weird parsing when I do
	150	// $e->$type[$attr], so I have to assign a ref.
	151	$f =& $e->$type;
	152	$f[$attr] = $fix;
	153	break;
	154	case 'tag_transform':
	155	$this->info_tag_transform[$params['element']] = $fix;
	156	break;
	157	case 'child':
	158	case 'content_model_type':
	159	$element = $params['element'];
	160	if (empty($this->info[$element])) {
	161	$e = $this->addBlankElement($element);
	162	} else {
	163	$e = $this->info[$element];
	164	}
	165	$e->$type = $fix;
	166	break;
	167	default:
	168	trigger_error("Fix type $type not supported", E_USER_ERROR);
	169	break;
	170	}
	171	}
	172	}
	173
	174	/**
	175	* Parses a fix name and determines what kind of fix it is, as well
	176	* as other information defined by the fix
	177	* @param $name String name of fix
	178	* @return array(string $fix_type, array $fix_parameters)
	179	* @note $fix_parameters is type dependant, see populate() for usage
	180	* of these parameters
	181	*/
	182	public function getFixType($name)
	183	{
	184	// parse it
	185	$property = $attr = null;
	186	if (strpos($name, '#') !== false) {
	187	list($name, $property) = explode('#', $name);
	188	}
	189	if (strpos($name, '@') !== false) {
	190	list($name, $attr) = explode('@', $name);
	191	}
	192
	193	// figure out the parameters
	194	$params = array();
	195	if ($name !== '') {
	196	$params['element'] = $name;
	197	}
	198	if (!is_null($attr)) {
	199	$params['attr'] = $attr;
	200	}
	201
	202	// special case: attribute transform
	203	if (!is_null($attr)) {
	204	if (is_null($property)) {
	205	$property = 'pre';
	206	}
	207	$type = 'attr_transform_' . $property;
	208	return array($type, $params);
	209	}
	210
	211	// special case: tag transform
	212	if (is_null($property)) {
	213	return array('tag_transform', $params);
	214	}
	215
	216	return array($property, $params);
	217
	218	}
	219
	220	/**
	221	* Defines all fixes the module will perform in a compact
	222	* associative array of fix name to fix implementation.
	223	* @return array
	224	*/
	225	public function makeFixes()
	226	{
	227	}
	228	}
	229
	230	// vim: et sw=4 sts=4