Merge pull request #66 from Kdecherf/fix/figure

See 'Tag omission' https://developer.mozilla.org/en-US/docs/Web/HTML/Element/figure

Signed-off-by: Kevin Decherf <kevin@kdecherf.com>

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: j0k3r

.github/workflows/coding-standards.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         php:
-          - "7.3"
+          - "7.4"
 
     steps:
       - name: "Checkout"
@@ -30,7 +30,7 @@ jobs:
         with:
           coverage: "none"
           php-version: "${{ matrix.php }}"
-          tools: cs2pr, composer:v1
+          tools: cs2pr, composer:v2
           ini-values: "date.timezone=Europe/Paris"
         env:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.php-cs-fixer.php

@@ -1,6 +1,11 @@
 <?php
 
-return PhpCsFixer\Config::create()
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->exclude(['vendor', 'var', 'web'])
+;
+
+return (new PhpCsFixer\Config())
     ->setUsingCache(true)
     ->setRiskyAllowed(true)
     ->setRules([
@@ -9,7 +14,7 @@ return PhpCsFixer\Config::create()
         'array_syntax' => ['syntax' => 'short'],
         'combine_consecutive_unsets' => true,
         'heredoc_to_nowdoc' => true,
-        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
+        'no_extra_blank_lines' => ['tokens' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block']],
         'no_unreachable_default_argument_value' => true,
         'no_useless_else' => true,
         'no_useless_return' => true,
@@ -22,9 +27,5 @@ return PhpCsFixer\Config::create()
         'strict_param' => true,
         'concat_space' => ['spacing' => 'one'],
     ])
-    ->setFinder(
+    ->setFinder($finder)
-        PhpCsFixer\Finder::create()
-            ->exclude(['vendor'])
-            ->in(__DIR__)
-    )
 ;

.travis.yml

@@ -24,7 +24,7 @@ before_install:
 
 install:
     - if [ "$CS_FIXER" != "run" ]; then composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update ; fi;
-    - composer update --prefer-dist --no-progress --no-suggest -o $
+    - composer update --prefer-dist --no-progress -o
     - php vendor/bin/simple-phpunit install
 
 before_script:

composer.json

@@ -32,7 +32,7 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.14",
         "monolog/monolog": "^1.24|^2.1",
-        "symfony/phpunit-bridge": "^4.2.3"
+        "symfony/phpunit-bridge": "^4.4|^5.3"
     },
     "suggest": {
         "ext-tidy": "Used to clean up given HTML and to avoid problems with bad HTML structure."

src/JSLikeHTMLElement.php

@@ -47,14 +47,16 @@ class JSLikeHTMLElement extends \DOMElement
     {
         if ('innerHTML' !== $name) {
             $trace = debug_backtrace();
-            trigger_error('Undefined property via __set(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
+            trigger_error('Undefined property via __set(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], \E_USER_NOTICE);
 
             return;
         }
 
         // first, empty the element
-        for ($x = $this->childNodes->length - 1; $x >= 0; --$x) {
+        if (isset($this->childNodes)) {
-            $this->removeChild($this->childNodes->item($x));
+            for ($x = $this->childNodes->length - 1; $x >= 0; --$x) {
+                $this->removeChild($this->childNodes->item($x));
+            }
         }
 
         // $value holds our new inner HTML
@@ -112,15 +114,17 @@ class JSLikeHTMLElement extends \DOMElement
         if ('innerHTML' === $name) {
             $inner = '';
 
-            foreach ($this->childNodes as $child) {
+            if (isset($this->childNodes)) {
-                $inner .= $this->ownerDocument->saveXML($child);
+                foreach ($this->childNodes as $child) {
+                    $inner .= $this->ownerDocument->saveXML($child);
+                }
             }
 
             return $inner;
         }
 
         $trace = debug_backtrace();
-        trigger_error('Undefined property via __get(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
+        trigger_error('Undefined property via __get(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], \E_USER_NOTICE);
     }
 
     public function __toString()

src/Readability.php

@@ -157,7 +157,7 @@ class Readability implements LoggerAwareInterface
         // replace excessive br's
         '/<br\s*\/?>\s*<p/i' => '<p',
         // replace empty tags that break layouts
-        '!<(?:a|div|p)[^>]+/>!is' => '',
+        '!<(?:a|div|p|figure)[^>]+/>!is' => '',
         // remove all attributes on text tags
         //'!<(\s*/?\s*(?:blockquote|br|hr|code|div|article|span|footer|aside|p|pre|dl|li|ul|ol)) [^>]+>!is' => "<\\1>",
         //single newlines cleanup
@@ -291,6 +291,11 @@ class Readability implements LoggerAwareInterface
         $innerDiv->appendChild($articleContent);
         $overlay->appendChild($innerDiv);
 
+        // without tidy the body can (sometimes) be wiped, so re-create it
+        if (false === isset($this->body->childNodes)) {
+            $this->body = $this->dom->createElement('body');
+        }
+
         // Clear the old HTML, insert the new content.
         $this->body->setInnerHtml('');
         $this->body->appendChild($overlay);
@@ -335,9 +340,9 @@ class Readability implements LoggerAwareInterface
             $footnoteLink = $articleLink->cloneNode(true);
             $refLink = $this->dom->createElement('a');
             $footnote = $this->dom->createElement('li');
-            $linkDomain = @parse_url($footnoteLink->getAttribute('href'), PHP_URL_HOST);
+            $linkDomain = @parse_url($footnoteLink->getAttribute('href'), \PHP_URL_HOST);
             if (!$linkDomain && isset($this->url)) {
-                $linkDomain = @parse_url($this->url, PHP_URL_HOST);
+                $linkDomain = @parse_url($this->url, \PHP_URL_HOST);
             }
 
             $linkText = $this->getInnerText($articleLink);
@@ -934,7 +939,7 @@ class Readability implements LoggerAwareInterface
             case 'DD':
             case 'DT':
             case 'LI':
-                $readability->value -= 2 * round($this->getLinkDensity($node), 0, PHP_ROUND_HALF_UP);
+                $readability->value -= 2 * round($this->getLinkDensity($node), 0, \PHP_ROUND_HALF_UP);
                 break;
             case 'ASIDE':
             case 'FOOTER':
@@ -988,6 +993,12 @@ class Readability implements LoggerAwareInterface
         for ($nodeIndex = 0; ($node = $allElements->item($nodeIndex)); ++$nodeIndex) {
             $tagName = $node->tagName;
 
+            $nodeContent = $node->getInnerHTML();
+            if (empty($nodeContent)) {
+                $this->logger->debug('Skipping empty node');
+                continue;
+            }
+
             // Some well known site uses sections as paragraphs.
             if (0 === strcasecmp($tagName, 'p') || 0 === strcasecmp($tagName, 'td') || 0 === strcasecmp($tagName, 'pre') || 0 === strcasecmp($tagName, 'section')) {
                 $nodesToScore[] = $node;
@@ -996,11 +1007,11 @@ class Readability implements LoggerAwareInterface
             // Turn divs into P tags where they have been used inappropriately
             //  (as in, where they contain no other block level elements).
             if (0 === strcasecmp($tagName, 'div') || 0 === strcasecmp($tagName, 'article') || 0 === strcasecmp($tagName, 'section')) {
-                if (!preg_match($this->regexps['divToPElements'], $node->getInnerHTML())) {
+                if (!preg_match($this->regexps['divToPElements'], $nodeContent)) {
                     $newNode = $this->dom->createElement('p');
 
                     try {
-                        $newNode->setInnerHtml($node->getInnerHTML());
+                        $newNode->setInnerHtml($nodeContent);
 
                         $node->parentNode->replaceChild($newNode, $node);
                         --$nodeIndex;
@@ -1025,7 +1036,7 @@ class Readability implements LoggerAwareInterface
                             continue;
                         }
 
-                        if (XML_TEXT_NODE === $childNode->nodeType) {
+                        if (\XML_TEXT_NODE === $childNode->nodeType) {
                             $p = $this->dom->createElement('p');
                             $p->setInnerHtml($childNode->nodeValue);
                             $p->setAttribute('data-readability-styled', 'true');
@@ -1151,7 +1162,7 @@ class Readability implements LoggerAwareInterface
                 // relatively small link density (5% or less) and be mostly unaffected by this operation.
                 // If not for this we would have used XPath to find maximum @readability.
                 $readability = $item->getAttributeNode('readability');
-                $readability->value = round($readability->value * (1 - $this->getLinkDensity($item)), 0, PHP_ROUND_HALF_UP);
+                $readability->value = round($readability->value * (1 - $this->getLinkDensity($item)), 0, \PHP_ROUND_HALF_UP);
 
                 if (!$topCandidate || $readability->value > (int) $topCandidate->getAttribute('readability')) {
                     $this->logger->debug('Candidate: ' . $item->getNodePath() . ' (' . $item->getAttribute('class') . ':' . $item->getAttribute('id') . ') with score ' . $readability->value);
@@ -1223,7 +1234,7 @@ class Readability implements LoggerAwareInterface
             $siblingNode = $siblingNodes->item($s);
             $siblingNodeName = $siblingNode->nodeName;
             $append = false;
-            $this->logger->debug('Looking at sibling node: ' . $siblingNode->getNodePath() . ((XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->hasAttribute('readability')) ? (' with score ' . $siblingNode->getAttribute('readability')) : ''));
+            $this->logger->debug('Looking at sibling node: ' . $siblingNode->getNodePath() . ((\XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->hasAttribute('readability')) ? (' with score ' . $siblingNode->getAttribute('readability')) : ''));
 
             if ($siblingNode->isSameNode($topCandidate)) {
                 $append = true;
@@ -1232,11 +1243,11 @@ class Readability implements LoggerAwareInterface
             $contentBonus = 0;
 
             // Give a bonus if sibling nodes and top candidates have the same classname.
-            if (XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->getAttribute('class') === $topCandidate->getAttribute('class') && '' !== $topCandidate->getAttribute('class')) {
+            if (\XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->getAttribute('class') === $topCandidate->getAttribute('class') && '' !== $topCandidate->getAttribute('class')) {
                 $contentBonus += ((int) $topCandidate->getAttribute('readability')) * 0.2;
             }
 
-            if (XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->hasAttribute('readability') && (((int) $siblingNode->getAttribute('readability')) + $contentBonus) >= $siblingScoreThreshold) {
+            if (\XML_ELEMENT_NODE === $siblingNode->nodeType && $siblingNode->hasAttribute('readability') && (((int) $siblingNode->getAttribute('readability')) + $contentBonus) >= $siblingScoreThreshold) {
                 $append = true;
             }
 
@@ -1381,7 +1392,7 @@ class Readability implements LoggerAwareInterface
         $this->logger->debug('Parsing URL: ' . $this->url);
 
         if ($this->url) {
-            $this->domainRegExp = '/' . strtr(preg_replace('/www\d*\./', '', parse_url($this->url, PHP_URL_HOST)), ['.' => '\.']) . '/';
+            $this->domainRegExp = '/' . strtr(preg_replace('/www\d*\./', '', parse_url($this->url, \PHP_URL_HOST)), ['.' => '\.']) . '/';
         }
 
         mb_internal_encoding('UTF-8');
@@ -1428,7 +1439,7 @@ class Readability implements LoggerAwareInterface
 
             $this->dom = new \DOMDocument();
             $this->dom->preserveWhiteSpace = false;
-            $this->dom->loadHTML($this->html, LIBXML_NOBLANKS | LIBXML_COMPACT | LIBXML_NOERROR);
+            $this->dom->loadHTML($this->html, \LIBXML_NOBLANKS | \LIBXML_COMPACT | \LIBXML_NOERROR);
 
             libxml_use_internal_errors(false);
         }

tests/ReadabilityTest.php

@@ -332,9 +332,9 @@ class ReadabilityTest extends \PHPUnit\Framework\TestCase
 
     public function testAutoClosingIframeNotThrowingException()
     {
-        error_reporting(E_ALL | E_STRICT);
+        error_reporting(\E_ALL | \E_STRICT);
         ini_set('display_errors', true);
-        set_error_handler([$this, 'error2Exception'], E_ALL | E_STRICT);
+        set_error_handler([$this, 'error2Exception'], \E_ALL | \E_STRICT);
 
         $data = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml" lang="ru-RU" prefix="og: http://ogp.me/ns#">
@@ -483,6 +483,19 @@ class ReadabilityTest extends \PHPUnit\Framework\TestCase
         $this->assertContains('<a href="#fnref1:fnfeed_2" rev="footnote"', $readability->getContent()->getInnerHtml());
     }
 
+    public function testWithWipedBody()
+    {
+        // from https://www.cs.cmu.edu/~rgs/alice-table.html
+        $html = file_get_contents('tests/fixtures/wipedBody.html');
+
+        $readability = $this->getReadability($html, 'http://0.0.0.0', 'libxml', false);
+        $readability->debug = true;
+        $res = $readability->init();
+
+        $this->assertTrue($res);
+        $this->assertContains('<a href="alice-I.html">Down the Rabbit-Hole</a>', $readability->getContent()->getInnerHtml());
+    }
+
     private function getReadability($html, $url = null, $parser = 'libxml', $useTidy = true)
     {
         $readability = new Readability($html, $url, $parser, $useTidy);

tests/fixtures/wipedBody.html

@@ -0,0 +1,67 @@
+
+<HTML>
+<HEAD>
+<TITLE>Alice's Adventures in Wonderland (Project Gutenberg)</TITLE>
+</HEAD>
+
+<frameset Rows="50, *">
+<frame src="alice-finfo.html">
+<frame src="alice-ftitle.html" name="alice-main">
+</frameset>
+
+<noframes>
+<BODY>
+<H1>Alice's Adventures in Wonderland</H1>
+                          <H1>Lewis Carroll</H1>
+               <H1>The Millennium Fulcrum Edition 3.0</H1>
+
+NOTE:  This is a hypertext formatted version of the Project Gutenberg edition.
+For more information, check the
+<A HREF="alice-small.txt">small print</A>
+or check out the
+<A HREF="ftp://uiarchive.cso.uiuc.edu/pub/etext/gutenberg/etext91/alice30.txt">
+full ascii text</A>.  The original Tenniel illustrations are also available
+due to the efforts of Project Gutenberg.  You can if you like, grab them as a
+<A HREF="ftp://uiarchive.cso.uiuc.edu/pub/etext/gutenberg/etext94/algif10.zip">
+"zip file"</A> or read the <A HREF="algif-small.txt">small print</A>
+that comes with them.
+This document is part of a small, but growing collection of html formatted
+etexts.  (Others may be found in either my <A
+HREF="http://www.cs.cmu.edu/Web/People/rgs/rgs-home.html">home page</A> or
+John Ockerbloom's indexes by <A
+HREF="http://www.cs.cmu.edu/Web/bookauthors.html">author</A> and <A
+HREF="http://www.cs.cmu.edu/Web/booktitles.html">title</A>.)
+I am still trying to figure out whether anyone else is interested in these
+on-line readable documents.  If you appreciate this document or would like to
+see more such, send me mail at "rgs@cs.cmu.edu".
+<P>
+<A HREF="alice01a.gif"><IMG SRC="alice01th.gif"></A>
+<P>
+<H2>CONTENTS</H2>
+<PRE>
+    CHAPTER I:    <A HREF="alice-I.html">Down the Rabbit-Hole</A>
+    CHAPTER II:   <A HREF="alice-II.html">The Pool of Tears</A>
+    CHAPTER III:  <A HREF="alice-III.html">A Caucus-Race and a Long Tale</A>
+    CHAPTER IV:   <A HREF="alice-IV.html">The Rabbit Sends in a Little Bill</A>
+    CHAPTER V:    <A HREF="alice-V.html">Advice from a Caterpillar</A>
+    CHAPTER VI:   <A HREF="alice-VI.html">Pig and Pepper</A>
+    CHAPTER VII:  <A HREF="alice-VII.html">A Mad Tea-Party</A>
+    CHAPTER VIII: <A HREF="alice-VIII.html">The Queen's Croquet-Ground</A>
+    CHAPTER IX:   <A HREF="alice-IX.html">The Mock Turtle's Story</A>
+    CHAPTER X:    <A HREF="alice-X.html">The Lobster Quadrille</A>
+    CHAPTER XI:   <A HREF="alice-XI.html">Who Stole the Tarts?</A>
+    CHAPTER XII:  <A HREF="alice-XII.html">Alice's Evidence</A>
+</PRE>
+
+<ADDRESS><A HREF="mailto:rgs@cs.cmu.edu">Robert Stockton</A></ADDRESS>
+<P>
+<!- Access counter added 5/25 1:49am ->
+<A href="http://www.dbasics.com/cgi-bin/pages.cgi?143205747"><IMG SRC="http://www.dbasics.com/cgi-bin/counter.cgi?143205747.2&(none)"></A> Access statistics from htmlZine
+<!- This page has been visited
+A HREF="http://counter.digits.com/wc?--info=yes&--name=rgsalice"
+IMG SRC="http://counter.digits.com/wc/-d/4/-r/-z/rgsalice"
+ ALIGN=absmiddle WIDTH=60 HEIGHT=20 BORDER=0 HSPACE=4 ALT="????"/A
+times since March 2, 1996. ->
+</BODY>
+</noframes>
+</HTML>