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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
|
<?php
namespace andreskrey\Readability;
use andreskrey\Readability\NodeClass\DOMDocument;
use andreskrey\Readability\NodeClass\DOMAttr;
use andreskrey\Readability\NodeClass\DOMCdataSection;
use andreskrey\Readability\NodeClass\DOMCharacterData;
use andreskrey\Readability\NodeClass\DOMComment;
use andreskrey\Readability\NodeClass\DOMDocumentFragment;
use andreskrey\Readability\NodeClass\DOMDocumentType;
use andreskrey\Readability\NodeClass\DOMElement;
use andreskrey\Readability\NodeClass\DOMNode;
use andreskrey\Readability\NodeClass\DOMNotation;
use andreskrey\Readability\NodeClass\DOMProcessingInstruction;
use andreskrey\Readability\NodeClass\DOMText;
/**
* Class Readability
*/
class Readability
{
/**
* @var string|null
*/
protected $title = null;
/**
* @var string|null
*/
protected $content = null;
/**
* @var string|null
*/
protected $image = null;
/**
* @var string|null
*/
protected $author = null;
/**
* @var Configuration
*/
private $configuration;
/**
* @var array
*/
private $regexps = [
'unlikelyCandidates' => '/banner|breadcrumbs|combx|comment|community|cover-wrap|disqus|extra|foot|header|legends|menu|modal|related|remark|replies|rss|shoutbox|sidebar|skyscraper|social|sponsor|supplemental|ad-break|agegate|pagination|pager|popup|yom-remote/i',
'okMaybeItsACandidate' => '/and|article|body|column|main|shadow/i',
'extraneous' => '/print|archive|comment|discuss|e[\-]?mail|share|reply|all|login|sign|single|utility/i',
'byline' => '/byline|author|dateline|writtenby|p-author/i',
'replaceFonts' => '/<(\/?)font[^>]*>/gi',
'normalize' => '/\s{2,}/',
'videos' => '/\/\/(www\.)?(dailymotion|youtube|youtube-nocookie|player\.vimeo)\.com/i',
'nextLink' => '/(next|weiter|continue|>([^\|]|$)|»([^\|]|$))/i',
'prevLink' => '/(prev|earl|old|new|<|«)/i',
'whitespace' => '/^\s*$/',
'hasContent' => '/\S$/',
// \x{00A0} is the unicode version of
'onlyWhitespace' => '/\x{00A0}|\s+/u'
];
private $defaultTagsToScore = [
'section',
'h2',
'h3',
'h4',
'h5',
'h6',
'p',
'td',
'pre',
];
/**
* @var array
*/
private $alterToDIVExceptions = [
'div',
'article',
'section',
'p',
// TODO, check if this is correct, #text elements do not exist in js
'#text',
];
private $dom;
/**
* Readability constructor.
*
* @param Configuration $configuration
*/
public function __construct(Configuration $configuration)
{
$this->configuration = $configuration;
// To avoid having a gazillion of errors on malformed HTMLs
libxml_use_internal_errors(true);
}
public function parse($html)
{
$this->dom = $this->loadHTML($html);
$this->metadata = $this->getMetadata();
$this->metadata['image'] = $this->getMainImage();
// Checking for minimum HTML to work with.
if (!($root = $this->dom->getElementsByTagName('body')->item(0)) || !$root->firstChild) {
return false;
}
$parseSuccessful = true;
while (true) {
$root = $root->firstChild;
$elementsToScore = $this->getNodes($root);
$result = $this->rateNodes($elementsToScore);
/*
* Now that we've gone through the full algorithm, check to see if
* we got any meaningful content. If we didn't, we may need to re-run
* grabArticle with different flags set. This gives us a higher likelihood of
* finding the content, and the sieve approach gives us a higher likelihood of
* finding the -right- content.
*/
// TODO Better way to count resulting text. Textcontent usually has alt titles and that stuff
// that doesn't really count to the quality of the result.
$length = 0;
foreach ($result->getElementsByTagName('p') as $p) {
$length += mb_strlen($p->textContent);
}
if ($result && mb_strlen(preg_replace('/\s/', '', $result->textContent)) < $this->getConfig()->getOption('wordThreshold')) {
$this->dom = $this->loadHTML($html);
$root = $this->dom->getElementsByTagName('body')->item(0);
if ($this->getConfig()->getOption('stripUnlikelyCandidates')) {
$this->getConfig()->setOption('stripUnlikelyCandidates', false);
} elseif ($this->getConfig()->getOption('weightClasses')) {
$this->getConfig()->setOption('weightClasses', false);
} elseif ($this->getConfig()->getOption('cleanConditionally')) {
$this->getConfig()->setOption('cleanConditionally', false);
} else {
$parseSuccessful = false;
break;
}
} else {
break;
}
}
if (!$parseSuccessful) {
return false;
}
$result = $this->postProcessContent($result);
// Todo, fix return, check for values, maybe create a function to create the return object
return [
'title' => isset($this->metadata['title']) ? $this->metadata['title'] : null,
'author' => isset($this->metadata['author']) ? $this->metadata['author'] : null,
'image' => isset($this->metadata['image']) ? $this->metadata['image'] : null,
'images' => $this->getImages(),
'article' => $result,
'html' => $result->C14N(),
'dir' => isset($this->metadata['articleDir']) ? $this->metadata['articleDir'] : null,
];
}
/**
* Creates a DOM Document object and loads the provided HTML on it.
*
* Used for the first load of Readability and subsequent reloads (when disabling flags and rescanning the text)
* Previous versions of Readability used this method one time and cloned the DOM to keep a backup. This caused bugs
* because cloning the DOM object keeps a relation between the clone and the original one, doing changes in both
* objects and ruining the backup.
*
* @param string $html
*
* @return DOMDocument
*/
private function loadHTML($html)
{
$dom = new DOMDocument('1.0', 'utf-8');
$dom->registerNodeClass('DOMAttr', DOMAttr::class);
$dom->registerNodeClass('DOMCdataSection', DOMCdataSection::class);
$dom->registerNodeClass('DOMCharacterData', DOMCharacterData::class);
$dom->registerNodeClass('DOMComment', DOMComment::class);
$dom->registerNodeClass('DOMDocumentFragment', DOMDocumentFragment::class);
$dom->registerNodeClass('DOMDocumentType', DOMDocumentType::class);
$dom->registerNodeClass('DOMElement', DOMElement::class);
$dom->registerNodeClass('DOMNode', DOMNode::class);
$dom->registerNodeClass('DOMNotation', DOMNotation::class);
$dom->registerNodeClass('DOMProcessingInstruction', DOMProcessingInstruction::class);
$dom->registerNodeClass('DOMText', DOMText::class);
if (!$this->configuration->getSubstituteEntities()) {
// Keep the original HTML entities
$dom->substituteEntities = false;
}
if ($this->configuration->getNormalizeEntities()) {
// Replace UTF-8 characters with the HTML Entity equivalent. Useful to fix html with mixed content
$html = mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8');
}
if ($this->configuration->getSummonCthulhu()) {
$html = preg_replace('/<script\b[^>]*>([\s\S]*?)<\/script>/', '', $html);
}
// Prepend the XML tag to avoid having issues with special characters. Should be harmless.
$dom->loadHTML('<?xml encoding="UTF-8">' . $html);
$dom->encoding = 'UTF-8';
$this->removeScripts($dom);
$this->prepDocument($dom);
return $dom;
}
/**
* Tries to guess relevant info from metadata of the html.
*
* @return array Metadata info. May have title, excerpt and or byline.
*/
private function getMetadata()
{
$metadata = $values = [];
// Match "description", or Twitter's "twitter:description" (Cards)
// in name attribute.
$namePattern = '/^\s*((twitter)\s*:\s*)?(description|title|image)\s*$/i';
// Match Facebook's Open Graph title & description properties.
$propertyPattern = '/^\s*og\s*:\s*(description|title|image)\s*$/i';
foreach ($this->dom->getElementsByTagName('meta') as $meta) {
/* @var DOMNode $meta */
$elementName = $meta->getAttribute('name');
$elementProperty = $meta->getAttribute('property');
if (in_array('author', [$elementName, $elementProperty])) {
$metadata['byline'] = $meta->getAttribute('content');
continue;
}
$name = null;
if (preg_match($namePattern, $elementName)) {
$name = $elementName;
} elseif (preg_match($propertyPattern, $elementProperty)) {
$name = $elementProperty;
}
if ($name) {
$content = $meta->getAttribute('content');
if ($content) {
// Convert to lowercase and remove any whitespace
// so we can match below.
$name = preg_replace('/\s/', '', strtolower($name));
$values[$name] = trim($content);
}
}
}
if (array_key_exists('description', $values)) {
$metadata['excerpt'] = $values['description'];
} elseif (array_key_exists('og:description', $values)) {
// Use facebook open graph description.
$metadata['excerpt'] = $values['og:description'];
} elseif (array_key_exists('twitter:description', $values)) {
// Use twitter cards description.
$metadata['excerpt'] = $values['twitter:description'];
}
$metadata['title'] = $this->getTitle();
if (!$metadata['title']) {
if (array_key_exists('og:title', $values)) {
// Use facebook open graph title.
$metadata['title'] = $values['og:title'];
} elseif (array_key_exists('twitter:title', $values)) {
// Use twitter cards title.
$metadata['title'] = $values['twitter:title'];
}
}
if (array_key_exists('og:image', $values) || array_key_exists('twitter:image', $values)) {
$metadata['image'] = array_key_exists('og:image', $values) ? $values['og:image'] : $values['twitter:image'];
} else {
$metadata['image'] = null;
}
return $metadata;
}
/**
* Tries to get the main article image. Will only update the metadata if the getMetadata function couldn't
* find a correct image.
*
* @return bool|string URL of the top image or false if unsuccessful.
*/
public function getMainImage()
{
$imgUrl = false;
if ($this->metadata['image'] !== null) {
$imgUrl = $this->metadata['image'];
}
if (!$imgUrl) {
foreach ($this->dom->getElementsByTagName('link') as $link) {
/** @var \DOMElement $link */
/*
* Check for the rel attribute, then check if the rel attribute is either img_src or image_src, and
* finally check for the existence of the href attribute, which should hold the image url.
*/
if ($link->hasAttribute('rel') && ($link->getAttribute('rel') === 'img_src' || $link->getAttribute('rel') === 'image_src') && $link->hasAttribute('href')) {
$imgUrl = $link->getAttribute('href');
break;
}
}
}
if (!empty($imgUrl) && $this->configuration->getFixRelativeURLs()) {
$imgUrl = $this->toAbsoluteURI($imgUrl);
}
return $imgUrl;
}
private function toAbsoluteURI($uri)
{
list($pathBase, $scheme, $prePath) = $this->getPathInfo($this->configuration->getOriginalURL());
// If this is already an absolute URI, return it.
if (preg_match('/^[a-zA-Z][a-zA-Z0-9\+\-\.]*:/', $uri)) {
return $uri;
}
// Scheme-rooted relative URI.
if (substr($uri, 0, 2) === '//') {
return $scheme . '://' . substr($uri, 2);
}
// Prepath-rooted relative URI.
if (substr($uri, 0, 1) === '/') {
return $prePath . $uri;
}
// Dotslash relative URI.
if (strpos($uri, './') === 0) {
return $pathBase . substr($uri, 2);
}
// Ignore hash URIs:
if (substr($uri, 0, 1) === '#') {
return $uri;
}
// Standard relative URI; add entire path. pathBase already includes a
// trailing "/".
return $pathBase . $uri;
}
/**
* @param string $url
*
* @return array [$pathBase, $scheme, $prePath]
*/
public function getPathInfo($url)
{
$pathBase = parse_url($url, PHP_URL_SCHEME) . '://' . parse_url($url, PHP_URL_HOST) . dirname(parse_url($url, PHP_URL_PATH)) . '/';
$scheme = parse_url($pathBase, PHP_URL_SCHEME);
$prePath = $scheme . '://' . parse_url($pathBase, PHP_URL_HOST);
return [$pathBase, $scheme, $prePath];
}
/**
* Gets nodes from the root element.
*
* @param $node DOMNode|DOMText
*
* @return array
*/
private function getNodes($node)
{
$stripUnlikelyCandidates = $this->configuration->getStripUnlikelyCandidates();
$elementsToScore = [];
/*
* First, node prepping. Trash nodes that look cruddy (like ones with the
* class name "comment", etc), and turn divs into P tags where they have been
* used inappropriately (as in, where they contain no other block level elements.)
*/
while ($node) {
$matchString = $node->getAttribute('class') . ' ' . $node->getAttribute('id');
// Remove DOMComments nodes as we don't need them and mess up children counting
if ($node->nodeTypeEqualsTo(XML_COMMENT_NODE)) {
$node = NodeUtility::removeAndGetNext($node);
continue;
}
// Check to see if this node is a byline, and remove it if it is.
if ($this->checkByline($node, $matchString)) {
$node = NodeUtility::removeAndGetNext($node);
continue;
}
// Remove unlikely candidates
if ($stripUnlikelyCandidates) {
if (
preg_match($this->regexps['unlikelyCandidates'], $matchString) &&
!preg_match($this->regexps['okMaybeItsACandidate'], $matchString) &&
!$node->tagNameEqualsTo('body') &&
!$node->tagNameEqualsTo('a')
) {
$node = NodeUtility::removeAndGetNext($node);
continue;
}
}
// Remove DIV, SECTION, and HEADER nodes without any content(e.g. text, image, video, or iframe).
if (($node->tagNameEqualsTo('div') || $node->tagNameEqualsTo('section') || $node->tagNameEqualsTo('header') ||
$node->tagNameEqualsTo('h1') || $node->tagNameEqualsTo('h2') || $node->tagNameEqualsTo('h3') ||
$node->tagNameEqualsTo('h4') || $node->tagNameEqualsTo('h5') || $node->tagNameEqualsTo('h6') ||
$node->tagNameEqualsTo('p')) &&
$node->isElementWithoutContent()) {
$node = NodeUtility::removeAndGetNext($node);
continue;
}
if (in_array(strtolower($node->nodeName), $this->defaultTagsToScore)) {
$elementsToScore[] = $node;
}
// Turn all divs that don't have children block level elements into p's
if ($node->tagNameEqualsTo('div')) {
/*
* Sites like http://mobile.slate.com encloses each paragraph with a DIV
* element. DIVs with only a P element inside and no text content can be
* safely converted into plain P elements to avoid confusing the scoring
* algorithm with DIVs with are, in practice, paragraphs.
*/
if (NodeUtility::hasSinglePNode($node)) {
$pNode = $node->getChildren(true)[0];
$node->replaceChild($pNode, $node);
$node = $pNode;
$elementsToScore[] = $node;
} elseif (!NodeUtility::hasSingleChildBlockElement($node)) {
NodeUtility::setNodeTag($node, 'p');
$elementsToScore[] = $node;
} else {
// EXPERIMENTAL
foreach ($node->getChildren() as $child) {
/** @var $child DOMNode */
if ($child->nodeType === XML_TEXT_NODE && mb_strlen(trim(NodeUtility::getTextContent($child))) > 0) {
$newNode = $node->createNode($child, 'p');
$child->replaceChild($newNode, $child);
}
}
}
}
$node = $node->getNextNode($node);
}
return $elementsToScore;
}
/**
* Checks if the node is a byline.
*
* @param DOMNode $node
* @param string $matchString
*
* @return bool
*/
private function checkByline($node, $matchString)
{
if (!$this->configuration->getArticleByLine()) {
return false;
}
/*
* Check if the byline is already set
*/
if (isset($this->metadata['byline'])) {
return false;
}
$rel = $node->getAttribute('rel');
if ($rel === 'author' || preg_match($this->regexps['byline'], $matchString) && $this->isValidByline($node->getTextContent())) {
$this->metadata['byline'] = trim($node->getTextContent());
return true;
}
return false;
}
/**
* Checks the validity of a byLine. Based on string length.
*
* @param string $text
*
* @return bool
*/
private function isValidByline($text)
{
if (gettype($text) == 'string') {
$byline = trim($text);
return (mb_strlen($byline) > 0) && (mb_strlen($text) < 100);
}
return false;
}
/**
* Removes all the scripts of the html.
*
* @param DOMDocument $dom
*/
private function removeScripts(DOMDocument $dom)
{
$toRemove = ['script', 'noscript'];
foreach ($toRemove as $tag) {
while ($script = $dom->getElementsByTagName($tag)) {
if ($script->item(0)) {
$script->item(0)->parentNode->removeChild($script->item(0));
} else {
break;
}
}
}
}
/**
* Prepares the document for parsing.
*
* @param DOMDocument $dom
*/
private function prepDocument(DOMDocument $dom)
{
/*
* DOMNodeList must be converted to an array before looping over it.
* This is done to avoid node shifting when removing nodes.
*
* Reverse traversing cannot be done here because we need to find brs that are right next to other brs.
* (If we go the other way around we need to search for previous nodes forcing the creation of new functions
* that will be used only here)
*/
foreach (iterator_to_array($dom->getElementsByTagName('br')) as $br) {
$next = $br->nextSibling;
/*
* Whether 2 or more <br> elements have been found and replaced with a
* <p> block.
*/
$replaced = false;
/*
* If we find a <br> chain, remove the <br>s until we hit another element
* or non-whitespace. This leaves behind the first <br> in the chain
* (which will be replaced with a <p> later).
*/
while (($next = NodeUtility::nextElement($next)) && ($next->nodeName === 'br')) {
$replaced = true;
$brSibling = $next->nextSibling;
$next->parentNode->removeChild($next);
$next = $brSibling;
}
/*
* If we removed a <br> chain, replace the remaining <br> with a <p>. Add
* all sibling nodes as children of the <p> until we hit another <br>
* chain.
*/
if ($replaced) {
$p = $dom->createElement('p');
$br->parentNode->replaceChild($p, $br);
$next = $p->nextSibling;
while ($next) {
// If we've hit another <br><br>, we're done adding children to this <p>.
if ($next->nodeName === 'br') {
$nextElem = NodeUtility::nextElement($next);
if ($nextElem && $nextElem->nodeName === 'br') {
break;
}
}
// Otherwise, make this node a child of the new <p>.
$sibling = $next->nextSibling;
$p->appendChild($next);
$next = $sibling;
}
}
}
// Replace font tags with span
$fonts = $dom->getElementsByTagName('font');
$length = $fonts->length;
for ($i = 0; $i < $length; $i++) {
$font = $fonts->item($length - 1 - $i);
NodeUtility::setNodeTag($font, 'span', true);
}
}
/**
* Assign scores to each node. This function will rate each node and return a DOMElement object for each one.
*
* @param array $nodes
*
* @return DOMDocument|bool
*/
private function rateNodes($nodes)
{
$candidates = [];
/** @var DOMElement $node */
foreach ($nodes as $node) {
if (is_null($node->parentNode)) {
continue;
}
// Discard nodes with less than 25 characters, without blank space
if (mb_strlen($node->getTextContent(true)) < 25) {
continue;
}
$ancestors = $node->getNodeAncestors();
// Exclude nodes with no ancestor
if (count($ancestors) === 0) {
continue;
}
// Start with a point for the paragraph itself as a base.
$contentScore = 1;
// Add points for any commas within this paragraph.
$contentScore += count(explode(',', $node->getTextContent(true)));
// For every 100 characters in this paragraph, add another point. Up to 3 points.
$contentScore += min(floor(mb_strlen($node->getTextContent(true)) / 100), 3);
/** @var DOMElement $level */
foreach ($ancestors as $level => $ancestor) {
$candidates[] = $ancestor;
/*
* Node score divider:
* - parent: 1 (no division)
* - grandparent: 2
* - great grandparent+: ancestor level * 3
*/
if ($level === 0) {
$scoreDivider = 1;
} elseif ($level === 1) {
$scoreDivider = 2;
} else {
$scoreDivider = $level * 3;
}
$currentScore = $ancestor->getContentScore();
$ancestor->setContentScore($currentScore + ($contentScore / $scoreDivider));
}
}
/*
* After we've calculated scores, loop through all of the possible
* candidate nodes we found and find the one with the highest score.
*/
$topCandidates = [];
foreach ($candidates as $candidate) {
/*
* Scale the final candidates score based on link density. Good content
* should have a relatively small link density (5% or less) and be mostly
* unaffected by this operation.
*/
$candidate->setContentScore($candidate->getContentScore() * (1 - $candidate->getLinkDensity()));
for ($i = 0; $i < $this->configuration->getMaxTopCandidates(); $i++) {
$aTopCandidate = isset($topCandidates[$i]) ? $topCandidates[$i] : null;
if (!$aTopCandidate || $candidate->getContentScore() > $aTopCandidate->getContentScore()) {
array_splice($topCandidates, $i, 0, [$candidate]);
if (count($topCandidates) > $this->configuration->getMaxTopCandidates()) {
array_pop($topCandidates);
}
break;
}
}
}
$topCandidate = isset($topCandidates[0]) ? $topCandidates[0] : null;
$neededToCreateTopCandidate = false;
$parentOfTopCandidate = null;
/*
* If we still have no top candidate, just use the body as a last resort.
* We also have to copy the body node so it is something we can modify.
*/
if ($topCandidate === null || $topCandidate->tagNameEqualsTo('body')) {
// Move all of the page's children into topCandidate
$topCandidate = new DOMDocument('1.0', 'utf-8');
$topCandidate->encoding = 'UTF-8';
$topCandidate->appendChild($topCandidate->createElement('div', ''));
$kids = $this->dom->getElementsByTagName('body')->item(0)->childNodes;
// Cannot be foreached, don't ask me why.
for ($i = 0; $i < $kids->length; $i++) {
$import = $topCandidate->importNode($kids->item($i), true);
$topCandidate->firstChild->appendChild($import);
}
// Readability must be created using firstChild to grab the DOMElement instead of the DOMDocument.
$topCandidate = new Readability($topCandidate->firstChild);
$topCandidate->initializeNode();
//TODO on the original code, $topCandidate is added to the page variable, which holds the whole HTML
// Should be done this here also? (line 823 in readability.js)
} elseif ($topCandidate) {
// Find a better top candidate node if it contains (at least three) nodes which belong to `topCandidates` array
// and whose scores are quite closed with current `topCandidate` node.
$alternativeCandidateAncestors = [];
for ($i = 1; $i < count($topCandidates); $i++) {
if ($topCandidates[$i]->getContentScore() / $topCandidate->getContentScore() >= 0.75) {
array_push($alternativeCandidateAncestors, $topCandidates[$i]->getNodeAncestors(false));
}
}
$MINIMUM_TOPCANDIDATES = 3;
if (count($alternativeCandidateAncestors) >= $MINIMUM_TOPCANDIDATES) {
$parentOfTopCandidate = $topCandidate->getParent();
while (!$parentOfTopCandidate->tagNameEqualsTo('body')) {
$listsContainingThisAncestor = 0;
for ($ancestorIndex = 0; $ancestorIndex < count($alternativeCandidateAncestors) && $listsContainingThisAncestor < $MINIMUM_TOPCANDIDATES; $ancestorIndex++) {
$listsContainingThisAncestor += (int)in_array($parentOfTopCandidate, $alternativeCandidateAncestors[$ancestorIndex]);
}
if ($listsContainingThisAncestor >= $MINIMUM_TOPCANDIDATES) {
$topCandidate = $parentOfTopCandidate;
break;
}
$parentOfTopCandidate = $parentOfTopCandidate->getParent();
}
}
/*
* Because of our bonus system, parents of candidates might have scores
* themselves. They get half of the node. There won't be nodes with higher
* scores than our topCandidate, but if we see the score going *up* in the first
* few steps up the tree, that's a decent sign that there might be more content
* lurking in other places that we want to unify in. The sibling stuff
* below does some of that - but only if we've looked high enough up the DOM
* tree.
*/
$parentOfTopCandidate = $topCandidate->getParent();
$lastScore = $topCandidate->getContentScore();
// The scores shouldn't get too low.
$scoreThreshold = $lastScore / 3;
/* @var Readability $parentOfTopCandidate */
while (!$parentOfTopCandidate->tagNameEqualsTo('body')) {
$parentScore = $parentOfTopCandidate->getContentScore();
if ($parentScore < $scoreThreshold) {
break;
}
if ($parentScore > $lastScore) {
// Alright! We found a better parent to use.
$topCandidate = $parentOfTopCandidate;
break;
}
$lastScore = $parentOfTopCandidate->getContentScore();
$parentOfTopCandidate = $parentOfTopCandidate->getParent();
}
// If the top candidate is the only child, use parent instead. This will help sibling
// joining logic when adjacent content is actually located in parent's sibling node.
$parentOfTopCandidate = $topCandidate->getParent();
while (!$parentOfTopCandidate->tagNameEqualsTo('body') && count($parentOfTopCandidate->getChildren(true)) === 1) {
$topCandidate = $parentOfTopCandidate;
$parentOfTopCandidate = $topCandidate->getParent();
}
}
/*
* Now that we have the top candidate, look through its siblings for content
* that might also be related. Things like preambles, content split by ads
* that we removed, etc.
*/
$articleContent = new DOMDocument('1.0', 'utf-8');
$articleContent->createElement('div');
$siblingScoreThreshold = max(10, $topCandidate->getContentScore() * 0.2);
// Keep potential top candidate's parent node to try to get text direction of it later.
$parentOfTopCandidate = $topCandidate->getParent();
$siblings = $parentOfTopCandidate->getChildren();
$hasContent = false;
/** @var Readability $sibling */
foreach ($siblings as $sibling) {
$append = false;
if ($sibling->compareNodes($sibling, $topCandidate)) {
$append = true;
} else {
$contentBonus = 0;
// Give a bonus if sibling nodes and top candidates have the example same classname
if ($sibling->getAttribute('class') === $topCandidate->getAttribute('class') && $topCandidate->getAttribute('class') !== '') {
$contentBonus += $topCandidate->getContentScore() * 0.2;
}
if ($sibling->getContentScore() + $contentBonus >= $siblingScoreThreshold) {
$append = true;
} elseif ($sibling->tagNameEqualsTo('p')) {
$linkDensity = $this->getLinkDensity($sibling);
$nodeContent = $sibling->getTextContent(true);
if (mb_strlen($nodeContent) > 80 && $linkDensity < 0.25) {
$append = true;
} elseif ($nodeContent && mb_strlen($nodeContent) < 80 && $linkDensity === 0 && preg_match('/\.( |$)/', $nodeContent)) {
$append = true;
}
}
}
if ($append) {
$hasContent = true;
if (!in_array(strtolower($sibling->getTagName()), $this->alterToDIVExceptions)) {
/*
* We have a node that isn't a common block level element, like a form or td tag.
* Turn it into a div so it doesn't get filtered out later by accident.
*/
$sibling->setNodeTag('div');
}
$import = $articleContent->importNode($sibling->getDOMNode(), true);
$articleContent->appendChild($import);
/*
* No node shifting needs to be check because when calling getChildren, an array is made with the
* children of the parent node, instead of using the DOMElement childNodes function, which, when used
* along with appendChild, would shift the nodes position and the current foreach will behave in
* unpredictable ways.
*/
}
}
$articleContent = $this->prepArticle($articleContent);
if ($hasContent) {
// Find out text direction from ancestors of final top candidate.
$ancestors = array_merge([$parentOfTopCandidate, $topCandidate], $parentOfTopCandidate->getNodeAncestors());
foreach ($ancestors as $ancestor) {
$articleDir = $ancestor->getAttribute('dir');
if ($articleDir) {
$this->metadata['articleDir'] = $articleDir;
break;
}
}
return $articleContent;
} else {
return false;
}
}
/**
* @return null|string
*/
public function __toString()
{
return $this->getContent();
}
/**
* @return string|null
*/
public function getTitle()
{
return $this->title;
}
/**
* @param null $title
*/
protected function setTitle($title)
{
$this->title = $title;
}
/**
* @return string|null
*/
public function getContent()
{
return $this->content;
}
/**
* @param null $content
*/
protected function setContent($content)
{
$this->content = $content;
}
/**
* @return string|null
*/
public function getImage()
{
return $this->image;
}
/**
* @param null $image
*/
protected function setImage($image)
{
$this->image = $image;
}
/**
* @return string|null
*/
public function getAuthor()
{
return $this->author;
}
/**
* @param null $author
*/
protected function setAuthor($author)
{
$this->author = $author;
}
}
|