summaryrefslogtreecommitdiffstats
path: root/vendor/fguillot/picofeed/lib/PicoFeed/Filter/Html.php
blob: 36ab3f18c18642abea3bd5554ec7d0549a75a6ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<?php

namespace PicoFeed\Filter;

use PicoFeed\Config\Config;
use PicoFeed\Client\Url;
use PicoFeed\Scraper\RuleLoader;
use PicoFeed\Parser\XmlParser;

/**
 * HTML Filter class
 *
 * @author  Frederic Guillot
 * @package Filter
 */
class Html
{
    /**
     * Config object
     *
     * @access private
     * @var \PicoFeed\Config\Config
     */
    private $config;

    /**
     * Unfiltered XML data
     *
     * @access private
     * @var string
     */
    private $input = '';

    /**
     * Filtered XML data
     *
     * @access private
     * @var string
     */
    private $output = '';

    /**
     * List of empty tags
     *
     * @access private
     * @var array
     */
    private $empty_tags = array();

    /**
     * Empty flag
     *
     * @access private
     * @var boolean
     */
    private $empty = true;

    /**
     * Tag instance
     *
     * @access public
     * @var \PicoFeed\Filter\Tag
     */
    public $tag = '';

    /**
     * Attribute instance
     *
     * @access public
     * @var \PicoFeed\Filter\Attribute
     */
    public $attribute = '';

    /**
     * The website to filter
     *
     * @access private
     * @var string
     */
    private $website;

    /**
     * Initialize the filter, all inputs data must be encoded in UTF-8 before
     *
     * @access public
     * @param  string  $html      HTML content
     * @param  string  $website   Site URL (used to build absolute URL)
     */
    public function __construct($html, $website)
    {
        $this->input = XmlParser::HtmlToXml($html);
        $this->output = '';
        $this->tag = new Tag;
        $this->website = $website;
        $this->attribute = new Attribute(new Url($website));
    }

    /**
     * Set config object
     *
     * @access public
     * @param  \PicoFeed\Config\Config  $config   Config instance
     * @return \PicoFeed\Filter\Html
     */
    public function setConfig($config)
    {
        $this->config = $config;

        if ($this->config !== null) {
            $this->attribute->setImageProxyCallback($this->config->getFilterImageProxyCallback());
            $this->attribute->setImageProxyUrl($this->config->getFilterImageProxyUrl());
            $this->attribute->setImageProxyProtocol($this->config->getFilterImageProxyProtocol());
            $this->attribute->setIframeWhitelist($this->config->getFilterIframeWhitelist(array()));
            $this->attribute->setIntegerAttributes($this->config->getFilterIntegerAttributes(array()));
            $this->attribute->setAttributeOverrides($this->config->getFilterAttributeOverrides(array()));
            $this->attribute->setRequiredAttributes($this->config->getFilterRequiredAttributes(array()));
            $this->attribute->setMediaBlacklist($this->config->getFilterMediaBlacklist(array()));
            $this->attribute->setMediaAttributes($this->config->getFilterMediaAttributes(array()));
            $this->attribute->setSchemeWhitelist($this->config->getFilterSchemeWhitelist(array()));
            $this->attribute->setWhitelistedAttributes($this->config->getFilterWhitelistedTags(array()));
            $this->tag->setWhitelistedTags(array_keys($this->config->getFilterWhitelistedTags(array())));
        }

        return $this;
    }

    /**
     * Run tags/attributes filtering
     *
     * @access public
     * @return string
     */
    public function execute()
    {
        $this->preFilter();

        $parser = xml_parser_create();

        xml_set_object($parser, $this);
        xml_set_element_handler($parser, 'startTag', 'endTag');
        xml_set_character_data_handler($parser, 'dataTag');
        xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
        xml_parse($parser, $this->input, true);
        xml_parser_free($parser);

        $this->postFilter();

        return $this->output;
    }

    /**
     * Called before XML parsing
     *
     * @access public
     */
    public function preFilter()
    {
        $this->input = $this->tag->removeBlacklistedTags($this->input);
    }

    /**
     * Called after XML parsing
     *
     * @access public
     */
    public function postFilter()
    {
        $this->output = $this->tag->removeEmptyTags($this->output);
        $this->output = $this->filterRules($this->output);
        $this->output = $this->tag->removeMultipleBreakTags($this->output);
        $this->output = trim($this->output);
    }

    /**
     * Called after XML parsing
     * @param string $content the content that should be filtered
     *
     * @access public
     */
    public function filterRules($content)
    {
        // the constructor should require a config, then this if can be removed
        if ($this->config === null) {
            $config = new Config;
        } else {
            $config = $this->config;
        }

        $loader = new RuleLoader($config);
        $rules = $loader->getRules($this->website);

        $url = new Url($this->website);
        $sub_url = $url->getFullPath();

        if (isset($rules['filter'])) {
            foreach ($rules['filter'] as $pattern => $rule) {
                if (preg_match($pattern, $sub_url)) {
                    foreach($rule as $search => $replace) {
                        $content = preg_replace($search, $replace, $content);
                    }
                }
            }
        }

        return $content;
    }

    /**
     * Parse opening tag
     *
     * @access public
     * @param  resource  $parser       XML parser
     * @param  string    $tag          Tag name
     * @param  array     $attributes   Tag attributes
     */
    public function startTag($parser, $tag, array $attributes)
    {
        $this->empty = true;

        if ($this->tag->isAllowed($tag, $attributes)) {

            $attributes = $this->attribute->filter($tag, $attributes);

            if ($this->attribute->hasRequiredAttributes($tag, $attributes)) {

                $attributes = $this->attribute->addAttributes($tag, $attributes);

                $this->output .= $this->tag->openHtmlTag($tag, $this->attribute->toHtml($attributes));
                $this->empty = false;
            }
        }

        $this->empty_tags[] = $this->empty;
    }

    /**
     * Parse closing tag
     *
     * @access public
     * @param  resource  $parser    XML parser
     * @param  string    $tag       Tag name
     */
    public function endTag($parser, $tag)
    {
        if (! array_pop($this->empty_tags) && $this->tag->isAllowedTag($tag)) {
            $this->output .= $this->tag->closeHtmlTag($tag);
        }
    }

    /**
     * Parse tag content
     *
     * @access public
     * @param  resource  $parser    XML parser
     * @param  string    $content   Tag content
     */
    public function dataTag($parser, $content)
    {
        // Replace &nbsp; with normal space
        $content = str_replace("\xc2\xa0", ' ', $content);
        $this->output .= Filter::escape($content);
    }
}