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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<?php
namespace andreskrey\Readability;
use League\HTMLToMarkdown\Element;
/**
* Class DOMElement.
*
* This is a extension of the original Element class from League\HTMLToMarkdown\Element.
* This class adds functions specific to Readability.php and overloads some of them to fit the purpose of this project.
*/
class Readability extends Element implements ReadabilityInterface
{
/**
* @var \DOMNode
*/
protected $node;
/**
* @var int
*/
protected $contentScore = 0;
/**
* @var array
*/
private $regexps = [
'positive' => '/article|body|content|entry|hentry|h-entry|main|page|pagination|post|text|blog|story/i',
'negative' => '/hidden|^hid$| hid$| hid |^hid |banner|combx|comment|com-|contact|foot|footer|footnote|masthead|media|meta|modal|outbrain|promo|related|scroll|share|shoutbox|sidebar|skyscraper|sponsor|shopping|tags|tool|widget/i',
];
/**
* Constructor.
*
* @param \DOMNode $node Selected element from DOMDocument
*/
public function __construct(\DOMNode $node)
{
parent::__construct($node);
if (get_class($node) !== 'DOMText') {
/*
* Restore the score if the object has been already scored.
*
* And if must be added before calling the getAttribute function, because if we reacht eh DOMDocument
* by geting the node parents we'll get a undefined function fatal error
*/
$score = 0;
if (get_class($node) !== 'DOMDocument') {
$score = $node->getAttribute('readability');
}
$this->setContentScore(($score) ? $score : 0);
}
}
/**
* Checks for the tag name. Case insensitive.
*
* @param string $value Name to compare to the current tag
*
* @return bool
*/
public function tagNameEqualsTo($value)
{
$tagName = $this->getTagName();
if (strtolower($value) === strtolower($tagName)) {
return true;
}
return false;
}
/**
* Checks if the current node has a single child and if that child is a P node.
* Useful to convert <div><p> nodes to a single <p> node and avoid confusing the scoring system since div with p
* tags are, in practice, paragraphs.
*
* @return bool
*/
public function hasSinglePNode()
{
if ($this->hasChildren()) {
$children = $this->getChildren();
if (count($children) === 1) {
if (strtolower($children[0]->getTagName()) === 'p') {
return true;
}
}
}
return false;
}
/**
* Get the ancestors of the current node.
*
* @param int $maxLevel Max amount of ancestors to get.
*
* @return array
*/
public function getNodeAncestors($maxLevel = 3)
{
$ancestors = [];
$level = 0;
$node = $this;
while ($node && $node->getParent()) {
$ancestors[] = new static($node->node);
$level++;
if ($level >= $maxLevel) {
break;
}
$node = $node->getParent();
}
return $ancestors;
}
/**
* Overloading the getParent function from League\HTMLToMarkdown\Element due to a bug when there are no more parents
* on the selected element.
*
* @return Readability|null
*/
public function getParent()
{
$node = $this->node->parentNode;
return ($node) ? new self($node) : null;
}
/**
* Returns all links from the current element.
*
* @return array|null
*/
public function getAllLinks()
{
if (($this->isText())) {
return null;
} else {
$links = [];
foreach ($this->node->getElementsByTagName('a') as $link) {
$links[] = new self($link);
}
return $links;
}
}
/**
* Initializer. Calculates the current score of the node and returns a full Readability object.
*
* @return Readability
*/
public function initializeNode()
{
switch ($this->getTagName()) {
case 'div':
$this->contentScore += 5;
break;
case 'pre':
case 'td':
case 'blockquote':
$this->contentScore += 3;
break;
case 'address':
case 'ol':
case 'ul':
case 'dl':
case 'dd':
case 'dt':
case 'li':
case 'form':
$this->contentScore -= 3;
break;
case 'h1':
case 'h2':
case 'h3':
case 'h4':
case 'h5':
case 'h6':
case 'th':
$this->contentScore -= 5;
break;
}
$this->contentScore += $this->getClassWeight();
return $this;
}
/**
* Calculates the weight of the class/id of the current element.
*
* @todo check for flag that lets this function run or not
*
* @return int
*/
public function getClassWeight()
{
// if(!Config::FLAG_WEIGHT_CLASSES) return 0;
$weight = 0;
// Look for a special classname
$class = $this->getAttribute('class');
if (trim($class)) {
if (preg_match($this->regexps['negative'], $class)) {
$weight -= 25;
}
if (preg_match($this->regexps['positive'], $class)) {
$weight += 25;
}
}
// Look for a special ID
$id = $this->getAttribute('class');
if (trim($id)) {
if (preg_match($this->regexps['negative'], $id)) {
$weight -= 25;
}
if (preg_match($this->regexps['positive'], $id)) {
$weight += 25;
}
}
return $weight;
}
/**
* Returns the current score of the Readability object.
*
* @return int
*/
public function getContentScore()
{
return $this->contentScore;
}
/**
* Returns the current score of the Readability object.
*
* @param int $score
*
* @return int
*/
public function setContentScore($score)
{
if (get_class($this->node) !== 'DOMDocument') {
// To prevent the -0 value
$this->contentScore = ($score === (float) -0) ? 0 : $score;
// Set score in an attribute of the tag to prevent losing it while creating new Readability objects.
$this->node->setAttribute('readability', $this->contentScore);
return $this->contentScore;
}
return 0;
}
/**
* Returns the full text of the node.
*
* @param bool $normalize Normalize white space?
*
* @return string
*/
public function getTextContent($normalize = false)
{
$nodeValue = $this->node->nodeValue;
if ($normalize) {
$nodeValue = trim(preg_replace('/\s{2,}/', ' ', $nodeValue));
}
return $nodeValue;
}
/**
* Sets the node name.
*
* @param string $value
*/
public function setNodeName($value)
{
$this->node->nodeName = $value;
}
/**
* Returns the current DOMNode.
*
* @return \DOMNode
*/
public function getDOMNode()
{
return $this->node;
}
public function removeAndGetNext($node)
{
$nextNode = $this->getNextNode($node, true);
$nextNode->node->parentNode->removeChild($node->node);
return $nextNode;
}
public function getNextNode($originalNode, $ignoreSelfAndKids = false)
{
/*
* Traverse the DOM from node to node, starting at the node passed in.
* Pass true for the second parameter to indicate this node itself
* (and its kids) are going away, and we want the next node over.
*
* Calling this in a loop will traverse the DOM depth-first.
*/
// First check for kids if those aren't being ignored
if (!$ignoreSelfAndKids && $originalNode->node->firstChild) {
return new self($originalNode->node->firstChild);
}
// Then for siblings...
if ($originalNode->node->nextSibling) {
return new self($originalNode->node->nextSibling);
}
// And finally, move up the parent chain *and* find a sibling
// (because this is depth-first traversal, we will have already
// seen the parent nodes themselves).
do {
$originalNode = $originalNode->getParent();
} while ($originalNode && !$originalNode->node->nextSibling);
return ($originalNode) ? new self($originalNode->node->nextSibling) : $originalNode;
}
}
|