2011-11-04 17:40:29 +00:00
< ? php
/**
* Content Extractor
*
* Uses patterns specified in site config files and auto detection ( hNews / PHP Readability )
* to extract content from HTML files .
*
2014-09-15 20:24:06 +00:00
* @ version 1.1
* @ date 2014 - 03 - 28
2011-11-04 17:40:29 +00:00
* @ author Keyvan Minoukadeh
2014-09-15 20:24:06 +00:00
* @ copyright 2014 Keyvan Minoukadeh
2011-11-04 17:40:29 +00:00
* @ license http :// www . gnu . org / licenses / agpl - 3.0 . html AGPL v3
*/
class ContentExtractor
{
protected static $tidy_config = array (
2017-02-18 15:06:19 +00:00
'clean' => false , // can't preserve wbr tabs if this is set to true
2011-11-04 17:40:29 +00:00
'output-xhtml' => true ,
'logical-emphasis' => true ,
'show-body-only' => false ,
2017-02-18 15:06:19 +00:00
'new-blocklevel-tags' => 'article aside footer header hgroup menu nav section details datagrid' ,
'new-inline-tags' => 'mark time meter progress data wbr' ,
2011-11-04 17:40:29 +00:00
'wrap' => 0 ,
'drop-empty-paras' => true ,
'drop-proprietary-attributes' => false ,
'enclose-text' => true ,
'enclose-block-text' => true ,
'merge-divs' => true ,
'merge-spans' => true ,
'char-encoding' => 'utf8' ,
'hide-comments' => true
);
protected $html ;
protected $config ;
2015-06-14 00:03:20 +00:00
protected $userSubmittedConfig ;
2011-11-04 17:40:29 +00:00
protected $title ;
2015-06-14 00:03:20 +00:00
protected $nativeAd = false ;
2013-04-18 14:11:06 +00:00
protected $author = array ();
protected $language ;
protected $date ;
2011-11-04 17:40:29 +00:00
protected $body ;
protected $success = false ;
2014-05-15 20:49:16 +00:00
protected $nextPageUrl ;
2017-02-18 15:06:19 +00:00
protected $opengraph = array ();
2014-09-15 20:24:06 +00:00
public $allowedParsers = array ( 'libxml' , 'html5php' );
public $defaultParser = 'libxml' ;
public $parserOverride = null ;
2013-04-18 14:11:06 +00:00
public $fingerprints = array ();
public $readability ;
2011-11-04 17:40:29 +00:00
public $debug = false ;
2014-05-15 20:49:16 +00:00
public $debugVerbose = false ;
2011-11-04 17:40:29 +00:00
2012-04-30 22:51:43 +00:00
function __construct ( $path , $fallback = null ) {
SiteConfig :: set_config_path ( $path , $fallback );
2011-11-04 17:40:29 +00:00
}
protected function debug ( $msg ) {
if ( $this -> debug ) {
$mem = round ( memory_get_usage () / 1024 , 2 );
$memPeak = round ( memory_get_peak_usage () / 1024 , 2 );
echo '* ' , $msg ;
2014-05-15 20:49:16 +00:00
if ( $this -> debugVerbose ) echo ' - mem used: ' , $mem , " (peak: $memPeak ) " ;
echo " \n " ;
2011-11-04 17:40:29 +00:00
ob_flush ();
flush ();
}
}
public function reset () {
2015-06-14 00:03:20 +00:00
// we do not reset $this->userSubmittedConfig (it gets reused)
2011-11-04 17:40:29 +00:00
$this -> html = null ;
$this -> readability = null ;
$this -> config = null ;
$this -> title = null ;
2015-06-14 00:03:20 +00:00
$this -> nativeAd = false ;
2011-11-04 17:40:29 +00:00
$this -> body = null ;
2013-04-18 14:11:06 +00:00
$this -> author = array ();
$this -> language = null ;
$this -> date = null ;
2014-05-15 20:49:16 +00:00
$this -> nextPageUrl = null ;
2011-11-04 17:40:29 +00:00
$this -> success = false ;
2017-02-18 15:06:19 +00:00
$this -> opengraph = array ();
2011-11-04 17:40:29 +00:00
}
2013-04-18 14:11:06 +00:00
public function findHostUsingFingerprints ( $html ) {
$this -> debug ( 'Checking fingerprints...' );
$head = substr ( $html , 0 , 8000 );
foreach ( $this -> fingerprints as $_fp => $_fphost ) {
$lookin = 'html' ;
if ( is_array ( $_fphost )) {
if ( isset ( $_fphost [ 'head' ]) && $_fphost [ 'head' ]) {
$lookin = 'head' ;
}
$_fphost = $_fphost [ 'hostname' ];
}
if ( strpos ( $$lookin , $_fp ) !== false ) {
$this -> debug ( " Found match: $_fphost " );
return $_fphost ;
}
}
2014-05-15 20:49:16 +00:00
$this -> debug ( 'No fingerprint matches' );
2013-04-18 14:11:06 +00:00
return false ;
}
2011-11-04 17:40:29 +00:00
2014-05-15 20:49:16 +00:00
// returns SiteConfig instance (joined in order: exact match, wildcard, fingerprint, global, default)
public function buildSiteConfig ( $url , $html = '' , $add_to_cache = true ) {
2011-11-04 17:40:29 +00:00
// extract host name
$host = @ parse_url ( $url , PHP_URL_HOST );
2014-05-15 20:49:16 +00:00
$host = strtolower ( $host );
if ( substr ( $host , 0 , 4 ) == 'www.' ) $host = substr ( $host , 4 );
// is merged version already cached?
if ( SiteConfig :: is_cached ( " $host .merged " )) {
2017-02-18 15:06:19 +00:00
$config = SiteConfig :: build ( " $host .merged " );
if ( $config ) {
$this -> debug ( " Returning cached and merged site config for $host " );
return $config ;
}
2014-05-15 20:49:16 +00:00
}
// let's build from site_config/custom/ and standard/
$config = SiteConfig :: build ( $host );
if ( $add_to_cache && $config && ! SiteConfig :: is_cached ( " $host " )) {
SiteConfig :: add_to_cache ( $host , $config );
}
// if no match, use defaults
if ( ! $config ) $config = new SiteConfig ();
// load fingerprint config?
if ( $config -> autodetect_on_failure ()) {
// check HTML for fingerprints
2013-04-18 14:11:06 +00:00
if ( ! empty ( $this -> fingerprints ) && ( $_fphost = $this -> findHostUsingFingerprints ( $html ))) {
2014-05-15 20:49:16 +00:00
if ( $config_fingerprint = SiteConfig :: build ( $_fphost )) {
$this -> debug ( " Appending site config settings from $_fphost (fingerprint match) " );
$config -> append ( $config_fingerprint );
if ( $add_to_cache && ! SiteConfig :: is_cached ( $_fphost )) {
//$config_fingerprint->cache_in_apc = true;
SiteConfig :: add_to_cache ( $_fphost , $config_fingerprint );
}
}
2013-04-18 14:11:06 +00:00
}
2014-05-15 20:49:16 +00:00
}
// load global config?
if ( $config -> autodetect_on_failure ()) {
if ( $config_global = SiteConfig :: build ( 'global' , true )) {
$this -> debug ( 'Appending site config settings from global.txt' );
$config -> append ( $config_global );
if ( $add_to_cache && ! SiteConfig :: is_cached ( 'global' )) {
//$config_global->cache_in_apc = true;
SiteConfig :: add_to_cache ( 'global' , $config_global );
}
2013-04-18 14:11:06 +00:00
}
2011-11-04 17:40:29 +00:00
}
2014-05-15 20:49:16 +00:00
// store copy of merged config
if ( $add_to_cache ) {
// do not store in APC if wildcard match
$use_apc = ( $host == $config -> cache_key );
$config -> cache_key = null ;
SiteConfig :: add_to_cache ( " $host .merged " , $config , $use_apc );
}
return $config ;
}
// returns true on success, false on failure
// $smart_tidy indicates that if tidy is used and no results are produced, we will
// try again without it. Tidy helps us deal with PHP's patchy HTML parsing most of the time
// but it has problems of its own which we try to avoid with this option.
public function process ( $html , $url , $smart_tidy = true ) {
$this -> reset ();
2015-06-14 00:03:20 +00:00
// use user submitted config and merge it with regular one
if ( isset ( $this -> userSubmittedConfig )) {
$this -> debug ( 'Using user-submitted site config' );
$this -> config = $this -> userSubmittedConfig ;
if ( $this -> config -> autodetect_on_failure ()) {
$this -> debug ( 'Merging user-submitted site config with site config files associated with this URL and/or content' );
$this -> config -> append ( $this -> buildSiteConfig ( $url , $html ));
}
} else {
$this -> config = $this -> buildSiteConfig ( $url , $html );
}
2011-11-04 17:40:29 +00:00
2013-04-18 14:11:06 +00:00
// do string replacements
2014-05-15 20:49:16 +00:00
if ( ! empty ( $this -> config -> find_string )) {
if ( count ( $this -> config -> find_string ) == count ( $this -> config -> replace_string )) {
$html = str_replace ( $this -> config -> find_string , $this -> config -> replace_string , $html , $_count );
$this -> debug ( " Strings replaced: $_count (find_string and/or replace_string) " );
} else {
$this -> debug ( 'Skipped string replacement - incorrect number of find-replace strings in site config' );
}
unset ( $_count );
2013-04-18 14:11:06 +00:00
}
2011-11-04 17:40:29 +00:00
// use tidy (if it exists)?
// This fixes problems with some sites which would otherwise
// trouble DOMDocument's HTML parsing. (Although sometimes it
// makes matters worse, which is why you can override it in site config files.)
$tidied = false ;
2014-05-15 20:49:16 +00:00
if ( $this -> config -> tidy () && function_exists ( 'tidy_parse_string' ) && $smart_tidy ) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Using Tidy' );
$tidy = tidy_parse_string ( $html , self :: $tidy_config , 'UTF8' );
if ( tidy_clean_repair ( $tidy )) {
$original_html = $html ;
$tidied = true ;
$html = $tidy -> value ;
}
unset ( $tidy );
}
// load and parse html
2014-09-15 20:24:06 +00:00
if ( $this -> parserOverride ) {
// from querystring: &parser=xxx
$_parser = $this -> parserOverride ;
} else {
// from site config file: parser: xxx
$_parser = $this -> config -> parser ();
}
// for backword compatibility...
if ( $_parser == 'html5lib' ) $_parser = 'html5php' ;
2014-05-15 20:49:16 +00:00
if ( ! in_array ( $_parser , $this -> allowedParsers )) {
2014-09-15 20:24:06 +00:00
$this -> debug ( " HTML parser $_parser not listed, using " . $this -> defaultParser . " instead " );
$_parser = $this -> defaultParser ;
2014-05-15 20:49:16 +00:00
}
$this -> debug ( " Attempting to parse HTML with $_parser " );
$this -> readability = new Readability ( $html , $url , $_parser );
2011-11-04 17:40:29 +00:00
// we use xpath to find elements in the given HTML document
// see http://en.wikipedia.org/wiki/XPath_1.0
$xpath = new DOMXPath ( $this -> readability -> dom );
2014-05-15 20:49:16 +00:00
// try to get next page link
foreach ( $this -> config -> next_page_link as $pattern ) {
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( is_string ( $elems )) {
$this -> nextPageUrl = trim ( $elems );
break ;
} elseif ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
foreach ( $elems as $item ) {
if ( $item instanceof DOMElement && $item -> hasAttribute ( 'href' )) {
$this -> nextPageUrl = $item -> getAttribute ( 'href' );
break 2 ;
} elseif ( $item instanceof DOMAttr && $item -> value ) {
$this -> nextPageUrl = $item -> value ;
break 2 ;
}
}
}
}
2015-06-14 00:03:20 +00:00
// check if this is a native ad
foreach ( $this -> config -> native_ad_clue as $pattern ) {
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
$this -> nativeAd = true ;
break ;
}
}
2013-04-18 14:11:06 +00:00
// try to get title
foreach ( $this -> config -> title as $pattern ) {
2014-05-15 20:49:16 +00:00
// $this->debug("Trying $pattern");
2013-04-18 14:11:06 +00:00
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( is_string ( $elems )) {
$this -> title = trim ( $elems );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Title expression evaluated as string: ' . $this -> title );
$this -> debug ( " ...XPath match: $pattern " );
2013-04-18 14:11:06 +00:00
break ;
} elseif ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
$this -> title = $elems -> item ( 0 ) -> textContent ;
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Title matched: ' . $this -> title );
$this -> debug ( " ...XPath match: $pattern " );
2013-04-18 14:11:06 +00:00
// remove title from document
try {
2014-05-15 21:03:31 +00:00
@ $elems -> item ( 0 ) -> parentNode -> removeChild ( $elems -> item ( 0 ));
2013-04-18 14:11:06 +00:00
} catch ( DOMException $e ) {
// do nothing
}
break ;
}
}
// try to get author (if it hasn't already been set)
if ( empty ( $this -> author )) {
foreach ( $this -> config -> author as $pattern ) {
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( is_string ( $elems )) {
if ( trim ( $elems ) != '' ) {
$this -> author [] = trim ( $elems );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Author expression evaluated as string: ' . trim ( $elems ));
$this -> debug ( " ...XPath match: $pattern " );
2013-04-18 14:11:06 +00:00
break ;
}
} elseif ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
foreach ( $elems as $elem ) {
if ( ! isset ( $elem -> parentNode )) continue ;
$this -> author [] = trim ( $elem -> textContent );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Author matched: ' . trim ( $elem -> textContent ));
}
if ( ! empty ( $this -> author )) {
$this -> debug ( " ...XPath match: $pattern " );
break ;
2013-04-18 14:11:06 +00:00
}
}
}
}
// try to get language
$_lang_xpath = array ( '//html[@lang]/@lang' , '//meta[@name="DC.language"]/@content' );
foreach ( $_lang_xpath as $pattern ) {
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( is_string ( $elems )) {
if ( trim ( $elems ) != '' ) {
$this -> language = trim ( $elems );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Language matched: ' . $this -> language );
2013-04-18 14:11:06 +00:00
break ;
}
} elseif ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
foreach ( $elems as $elem ) {
if ( ! isset ( $elem -> parentNode )) continue ;
$this -> language = trim ( $elem -> textContent );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Language matched: ' . $this -> language );
2013-04-18 14:11:06 +00:00
}
if ( $this -> language ) break ;
}
}
2017-02-18 15:06:19 +00:00
// try to open graph properties
$elems = @ $xpath -> query ( " //head//meta[@property='og:title' or @property='og:type' or @property='og:url' or @property='og:image' or @property='og:description'] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Extracting Open Graph elements' );
foreach ( $elems as $elem ) {
if ( $elem -> hasAttribute ( 'content' )) {
$_prop = strtolower ( $elem -> getAttribute ( 'property' ));
$_val = $elem -> getAttribute ( 'content' );
// currently one of each is returned, so we keep the first one
if ( ! isset ( $this -> opengraph [ $_prop ])) {
$this -> opengraph [ $_prop ] = $_val ;
}
}
}
unset ( $_prop , $_val );
}
2013-04-18 14:11:06 +00:00
// try to get date
foreach ( $this -> config -> date as $pattern ) {
$elems = @ $xpath -> evaluate ( $pattern , $this -> readability -> dom );
if ( is_string ( $elems )) {
2014-05-15 20:49:16 +00:00
$this -> date = strtotime ( trim ( $elems , " ; \t \n \r \0 \x0B " ));
2013-04-18 14:11:06 +00:00
} elseif ( $elems instanceof DOMNodeList && $elems -> length > 0 ) {
$this -> date = $elems -> item ( 0 ) -> textContent ;
$this -> date = strtotime ( trim ( $this -> date , " ; \t \n \r \0 \x0B " ));
// remove date from document
// $elems->item(0)->parentNode->removeChild($elems->item(0));
}
if ( ! $this -> date ) {
$this -> date = null ;
} else {
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Date matched: ' . date ( 'Y-m-d H:i:s' , $this -> date ));
$this -> debug ( " ...XPath match: $pattern " );
2013-04-18 14:11:06 +00:00
break ;
}
}
2011-11-04 17:40:29 +00:00
// strip elements (using xpath expressions)
foreach ( $this -> config -> strip as $pattern ) {
$elems = @ $xpath -> query ( $pattern , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' elements (strip)' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
2014-09-15 20:24:06 +00:00
if ( $elems -> item ( $i ) -> parentNode ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
2011-11-04 17:40:29 +00:00
}
}
}
2013-04-18 14:11:06 +00:00
2011-11-04 17:40:29 +00:00
// strip elements (using id and class attribute values)
foreach ( $this -> config -> strip_id_or_class as $string ) {
$string = strtr ( $string , array ( " ' " => '' , '"' => '' ));
$elems = @ $xpath -> query ( " //*[contains(@class, ' $string ') or contains(@id, ' $string ')] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' elements (strip_id_or_class)' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
}
}
2013-04-18 14:11:06 +00:00
2011-11-04 17:40:29 +00:00
// strip images (using src attribute values)
foreach ( $this -> config -> strip_image_src as $string ) {
$string = strtr ( $string , array ( " ' " => '' , '"' => '' ));
$elems = @ $xpath -> query ( " //img[contains(@src, ' $string ')] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' image elements' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
}
}
// strip elements using Readability.com and Instapaper.com ignore class names
// .entry-unrelated and .instapaper_ignore
// See https://www.readability.com/publishers/guidelines/#view-plainGuidelines
// and http://blog.instapaper.com/post/730281947
$elems = @ $xpath -> query ( " //*[contains(concat(' ',normalize-space(@class),' '),' entry-unrelated ') or contains(concat(' ',normalize-space(@class),' '),' instapaper_ignore ')] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' .entry-unrelated,.instapaper_ignore elements' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
}
// strip elements that contain style="display: none;"
$elems = @ $xpath -> query ( " //*[contains(@style,'display:none')] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' elements with inline display:none style' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
}
2017-02-18 15:06:19 +00:00
// strip empty a elements
$elems = $xpath -> query ( " //a[not(./*) and normalize-space(.)=''] " , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Stripping ' . $elems -> length . ' empty a elements' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$elems -> item ( $i ) -> parentNode -> removeChild ( $elems -> item ( $i ));
}
}
2011-11-04 17:40:29 +00:00
// try to get body
foreach ( $this -> config -> body as $pattern ) {
$elems = @ $xpath -> query ( $pattern , $this -> readability -> dom );
// check for matches
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'Body matched' );
2014-05-15 20:49:16 +00:00
$this -> debug ( " ...XPath match: $pattern " );
2011-11-04 17:40:29 +00:00
if ( $elems -> length == 1 ) {
$this -> body = $elems -> item ( 0 );
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
$this -> debug ( '...pruning content' );
2011-11-04 17:40:29 +00:00
$this -> readability -> prepArticle ( $this -> body );
}
break ;
} else {
$this -> body = $this -> readability -> dom -> createElement ( 'div' );
$this -> debug ( $elems -> length . ' body elems found' );
foreach ( $elems as $elem ) {
2013-04-18 14:11:06 +00:00
if ( ! isset ( $elem -> parentNode )) continue ;
2011-11-04 17:40:29 +00:00
$isDescendant = false ;
foreach ( $this -> body -> childNodes as $parent ) {
if ( $this -> isDescendant ( $parent , $elem )) {
$isDescendant = true ;
break ;
}
}
if ( $isDescendant ) {
2014-05-15 20:49:16 +00:00
$this -> debug ( '...element is child of another body element, skipping.' );
2011-11-04 17:40:29 +00:00
} else {
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $elem );
}
2014-05-15 20:49:16 +00:00
$this -> debug ( '...element added to body' );
2011-11-04 17:40:29 +00:00
$this -> body -> appendChild ( $elem );
}
}
2014-05-15 20:56:02 +00:00
if ( $this -> body -> hasChildNodes ()) break ;
2011-11-04 17:40:29 +00:00
}
}
}
// auto detect?
2013-04-18 14:11:06 +00:00
$detect_title = $detect_body = $detect_author = $detect_date = false ;
2011-11-04 17:40:29 +00:00
// detect title?
if ( ! isset ( $this -> title )) {
2014-05-15 20:49:16 +00:00
if ( empty ( $this -> config -> title ) || $this -> config -> autodetect_on_failure ()) {
2011-11-04 17:40:29 +00:00
$detect_title = true ;
}
}
// detect body?
if ( ! isset ( $this -> body )) {
2014-05-15 20:49:16 +00:00
if ( empty ( $this -> config -> body ) || $this -> config -> autodetect_on_failure ()) {
2011-11-04 17:40:29 +00:00
$detect_body = true ;
}
}
2013-04-18 14:11:06 +00:00
// detect author?
if ( empty ( $this -> author )) {
2014-05-15 20:49:16 +00:00
if ( empty ( $this -> config -> author ) || $this -> config -> autodetect_on_failure ()) {
2013-04-18 14:11:06 +00:00
$detect_author = true ;
}
}
// detect date?
if ( ! isset ( $this -> date )) {
2014-05-15 20:49:16 +00:00
if ( empty ( $this -> config -> date ) || $this -> config -> autodetect_on_failure ()) {
2013-04-18 14:11:06 +00:00
$detect_date = true ;
}
}
2011-11-04 17:40:29 +00:00
// check for hNews
if ( $detect_title || $detect_body ) {
// check for hentry
$elems = @ $xpath -> query ( " //*[contains(concat(' ',normalize-space(@class),' '),' hentry ')] " , $this -> readability -> dom );
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'hNews: found hentry' );
$hentry = $elems -> item ( 0 );
if ( $detect_title ) {
// check for entry-title
$elems = @ $xpath -> query ( " .//*[contains(concat(' ',normalize-space(@class),' '),' entry-title ')] " , $hentry );
if ( $elems && $elems -> length > 0 ) {
$this -> title = $elems -> item ( 0 ) -> textContent ;
2014-05-15 20:49:16 +00:00
$this -> debug ( 'hNews: found entry-title: ' . $this -> title );
2013-04-18 14:11:06 +00:00
// remove title from document
$elems -> item ( 0 ) -> parentNode -> removeChild ( $elems -> item ( 0 ));
2011-11-04 17:40:29 +00:00
$detect_title = false ;
}
}
2013-04-18 14:11:06 +00:00
if ( $detect_date ) {
// check for time element with pubdate attribute
2014-09-15 20:24:06 +00:00
$elems = @ $xpath -> query ( " .//time[@pubdate or @pubDate] | .//abbr[contains(concat(' ',normalize-space(@class),' '),' published ')] " , $hentry );
2013-04-18 14:11:06 +00:00
if ( $elems && $elems -> length > 0 ) {
$this -> date = strtotime ( trim ( $elems -> item ( 0 ) -> textContent ));
// remove date from document
//$elems->item(0)->parentNode->removeChild($elems->item(0));
if ( $this -> date ) {
2014-05-15 20:49:16 +00:00
$this -> debug ( 'hNews: found publication date: ' . date ( 'Y-m-d H:i:s' , $this -> date ));
2013-04-18 14:11:06 +00:00
$detect_date = false ;
} else {
$this -> date = null ;
}
}
}
if ( $detect_author ) {
// check for time element with pubdate attribute
$elems = @ $xpath -> query ( " .//*[contains(concat(' ',normalize-space(@class),' '),' vcard ') and (contains(concat(' ',normalize-space(@class),' '),' author ') or contains(concat(' ',normalize-space(@class),' '),' byline '))] " , $hentry );
if ( $elems && $elems -> length > 0 ) {
$author = $elems -> item ( 0 );
$fn = @ $xpath -> query ( " .//*[contains(concat(' ',normalize-space(@class),' '),' fn ')] " , $author );
if ( $fn && $fn -> length > 0 ) {
foreach ( $fn as $_fn ) {
if ( trim ( $_fn -> textContent ) != '' ) {
$this -> author [] = trim ( $_fn -> textContent );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'hNews: found author: ' . trim ( $_fn -> textContent ));
2013-04-18 14:11:06 +00:00
}
}
} else {
if ( trim ( $author -> textContent ) != '' ) {
$this -> author [] = trim ( $author -> textContent );
2014-05-15 20:49:16 +00:00
$this -> debug ( 'hNews: found author: ' . trim ( $author -> textContent ));
2013-04-18 14:11:06 +00:00
}
}
$detect_author = empty ( $this -> author );
}
}
2011-11-04 17:40:29 +00:00
// check for entry-content.
// according to hAtom spec, if there are multiple elements marked entry-content,
// we include all of these in the order they appear - see http://microformats.org/wiki/hatom#Entry_Content
if ( $detect_body ) {
$elems = @ $xpath -> query ( " .//*[contains(concat(' ',normalize-space(@class),' '),' entry-content ')] " , $hentry );
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'hNews: found entry-content' );
if ( $elems -> length == 1 ) {
// what if it's empty? (some sites misuse hNews - place their content outside an empty entry-content element)
$e = $elems -> item ( 0 );
if (( $e -> tagName == 'img' ) || ( trim ( $e -> textContent ) != '' )) {
$this -> body = $elems -> item ( 0 );
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $this -> body );
}
$detect_body = false ;
} else {
$this -> debug ( 'hNews: skipping entry-content - appears not to contain content' );
}
unset ( $e );
} else {
$this -> body = $this -> readability -> dom -> createElement ( 'div' );
$this -> debug ( $elems -> length . ' entry-content elems found' );
foreach ( $elems as $elem ) {
2013-04-18 14:11:06 +00:00
if ( ! isset ( $elem -> parentNode )) continue ;
2011-11-04 17:40:29 +00:00
$isDescendant = false ;
foreach ( $this -> body -> childNodes as $parent ) {
if ( $this -> isDescendant ( $parent , $elem )) {
$isDescendant = true ;
break ;
}
}
if ( $isDescendant ) {
$this -> debug ( 'Element is child of another body element, skipping.' );
} else {
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $elem );
}
$this -> debug ( 'Element added to body' );
$this -> body -> appendChild ( $elem );
}
}
$detect_body = false ;
}
}
}
}
}
// check for elements marked with instapaper_title
if ( $detect_title ) {
// check for instapaper_title
$elems = @ $xpath -> query ( " //*[contains(concat(' ',normalize-space(@class),' '),' instapaper_title ')] " , $this -> readability -> dom );
if ( $elems && $elems -> length > 0 ) {
$this -> title = $elems -> item ( 0 ) -> textContent ;
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Title found (.instapaper_title): ' . $this -> title );
2013-04-18 14:11:06 +00:00
// remove title from document
$elems -> item ( 0 ) -> parentNode -> removeChild ( $elems -> item ( 0 ));
2011-11-04 17:40:29 +00:00
$detect_title = false ;
}
}
// check for elements marked with instapaper_body
if ( $detect_body ) {
$elems = @ $xpath -> query ( " //*[contains(concat(' ',normalize-space(@class),' '),' instapaper_body ')] " , $this -> readability -> dom );
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'body found (.instapaper_body)' );
$this -> body = $elems -> item ( 0 );
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $this -> body );
}
$detect_body = false ;
}
}
2014-09-15 20:24:06 +00:00
// check for elements marked with itemprop="articleBody" (from Schema.org)
if ( $detect_body ) {
$elems = @ $xpath -> query ( " //*[@itemprop='articleBody'] " , $this -> readability -> dom );
if ( $elems && $elems -> length > 0 ) {
$this -> debug ( 'body found (Schema.org itemprop="articleBody")' );
if ( $elems -> length == 1 ) {
// what if it's empty? (content placed outside an empty itemprop='articleBody' element)
$e = $elems -> item ( 0 );
if (( $e -> tagName == 'img' ) || ( trim ( $e -> textContent ) != '' )) {
$this -> body = $elems -> item ( 0 );
// prune (clean up elements that may not be content)
if ( $this -> config -> prune ()) {
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $this -> body );
}
$detect_body = false ;
} else {
$this -> debug ( 'Schema.org: skipping itemprop="articleBody" - appears not to contain content' );
}
unset ( $e );
} else {
$this -> body = $this -> readability -> dom -> createElement ( 'div' );
$this -> debug ( $elems -> length . ' itemprop="articleBody" elems found' );
foreach ( $elems as $elem ) {
if ( ! isset ( $elem -> parentNode )) continue ;
$isDescendant = false ;
foreach ( $this -> body -> childNodes as $parent ) {
if ( $this -> isDescendant ( $parent , $elem )) {
$isDescendant = true ;
break ;
}
}
if ( $isDescendant ) {
$this -> debug ( 'Element is child of another body element, skipping.' );
} else {
// prune (clean up elements that may not be content)
if ( $this -> config -> prune ()) {
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $elem );
}
$this -> debug ( 'Element added to body' );
$this -> body -> appendChild ( $elem );
}
}
$detect_body = false ;
}
}
}
2013-04-18 14:11:06 +00:00
// Find author in rel="author" marked element
// We only use this if there's exactly one.
// If there's more than one, it could indicate more than
// one author, but it could also indicate that we're processing
// a page listing different articles with different authors.
if ( $detect_author ) {
$elems = @ $xpath -> query ( " //a[contains(concat(' ',normalize-space(@rel),' '),' author ')] " , $this -> readability -> dom );
if ( $elems && $elems -> length == 1 ) {
$author = trim ( $elems -> item ( 0 ) -> textContent );
if ( $author != '' ) {
2014-05-15 20:49:16 +00:00
$this -> debug ( " Author found (rel= \" author \" ): $author " );
2013-04-18 14:11:06 +00:00
$this -> author [] = $author ;
$detect_author = false ;
}
}
}
// Find date in pubdate marked time element
// For the same reason given above, we only use this
// if there's exactly one element.
if ( $detect_date ) {
2014-09-15 20:24:06 +00:00
$elems = @ $xpath -> query ( " //time[@pubdate or @pubDate] " , $this -> readability -> dom );
2013-04-18 14:11:06 +00:00
if ( $elems && $elems -> length == 1 ) {
$this -> date = strtotime ( trim ( $elems -> item ( 0 ) -> textContent ));
// remove date from document
//$elems->item(0)->parentNode->removeChild($elems->item(0));
if ( $this -> date ) {
2014-05-15 20:49:16 +00:00
$this -> debug ( 'Date found (pubdate marked time element): ' . date ( 'Y-m-d H:i:s' , $this -> date ));
2013-04-18 14:11:06 +00:00
$detect_date = false ;
} else {
$this -> date = null ;
}
}
}
2011-11-04 17:40:29 +00:00
// still missing title or body, so we detect using Readability
if ( $detect_title || $detect_body ) {
$this -> debug ( 'Using Readability' );
// clone body if we're only using Readability for title (otherwise it may interfere with body element)
if ( isset ( $this -> body )) $this -> body = $this -> body -> cloneNode ( true );
$success = $this -> readability -> init ();
}
if ( $detect_title ) {
$this -> debug ( 'Detecting title' );
$this -> title = $this -> readability -> getTitle () -> textContent ;
}
if ( $detect_body && $success ) {
$this -> debug ( 'Detecting body' );
$this -> body = $this -> readability -> getContent ();
if ( $this -> body -> childNodes -> length == 1 && $this -> body -> firstChild -> nodeType === XML_ELEMENT_NODE ) {
$this -> body = $this -> body -> firstChild ;
}
// prune (clean up elements that may not be content)
2014-05-15 20:49:16 +00:00
if ( $this -> config -> prune ()) {
2011-11-04 17:40:29 +00:00
$this -> debug ( 'Pruning content' );
$this -> readability -> prepArticle ( $this -> body );
}
}
if ( isset ( $this -> body )) {
// remove scripts
$this -> readability -> removeScripts ( $this -> body );
2013-04-18 14:11:06 +00:00
// remove any h1-h6 elements that appear as first thing in the body
// and which match our title
if ( isset ( $this -> title ) && ( $this -> title != '' )) {
$firstChild = $this -> body -> firstChild ;
while ( $firstChild -> nodeType && ( $firstChild -> nodeType !== XML_ELEMENT_NODE )) {
$firstChild = $firstChild -> nextSibling ;
}
if (( $firstChild -> nodeType === XML_ELEMENT_NODE )
&& in_array ( strtolower ( $firstChild -> tagName ), array ( 'h1' , 'h2' , 'h3' , 'h4' , 'h5' , 'h6' ))
&& ( strtolower ( trim ( $firstChild -> textContent )) == strtolower ( trim ( $this -> title )))) {
$this -> body -> removeChild ( $firstChild );
}
}
2014-05-15 20:56:02 +00:00
// prevent self-closing iframes
$elems = $this -> body -> getElementsByTagName ( 'iframe' );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$e = $elems -> item ( $i );
if ( ! $e -> hasChildNodes ()) {
$e -> appendChild ( $this -> body -> ownerDocument -> createTextNode ( '[embedded content]' ));
}
}
// remove image lazy loading - WordPress plugin http://wordpress.org/extend/plugins/lazy-load/
// the plugin replaces the src attribute to point to a 1x1 gif and puts the original src
// inside the data-lazy-src attribute. It also places the original image inside a noscript element
// next to the amended one.
$elems = @ $xpath -> query ( " //img[@data-lazy-src] " , $this -> body );
for ( $i = $elems -> length - 1 ; $i >= 0 ; $i -- ) {
$e = $elems -> item ( $i );
// let's see if we can grab image from noscript
if ( $e -> nextSibling !== null && $e -> nextSibling -> nodeName === 'noscript' ) {
$_new_elem = $e -> ownerDocument -> createDocumentFragment ();
@ $_new_elem -> appendXML ( $e -> nextSibling -> innerHTML );
$e -> nextSibling -> parentNode -> replaceChild ( $_new_elem , $e -> nextSibling );
$e -> parentNode -> removeChild ( $e );
} else {
// Use data-lazy-src as src value
$e -> setAttribute ( 'src' , $e -> getAttribute ( 'data-lazy-src' ));
$e -> removeAttribute ( 'data-lazy-src' );
}
}
2011-11-04 17:40:29 +00:00
$this -> success = true ;
}
// if we've had no success and we've used tidy, there's a chance
// that tidy has messed up. So let's try again without tidy...
if ( ! $this -> success && $tidied && $smart_tidy ) {
$this -> debug ( 'Trying again without tidy' );
$this -> process ( $original_html , $url , false );
}
return $this -> success ;
}
private function isDescendant ( DOMElement $parent , DOMElement $child ) {
$node = $child -> parentNode ;
while ( $node != null ) {
if ( $node -> isSameNode ( $parent )) return true ;
$node = $node -> parentNode ;
}
return false ;
}
2015-06-14 00:03:20 +00:00
public function setUserSubmittedConfig ( $config_string ) {
$this -> userSubmittedConfig = SiteConfig :: build_from_string ( $config_string );
}
2011-11-04 17:40:29 +00:00
public function getContent () {
return $this -> body ;
}
2015-06-14 00:03:20 +00:00
2017-02-18 15:06:19 +00:00
public function getOpenGraph () {
return $this -> opengraph ;
}
2015-06-14 00:03:20 +00:00
public function isNativeAd () {
return $this -> nativeAd ;
}
2013-04-18 14:11:06 +00:00
2011-11-04 17:40:29 +00:00
public function getTitle () {
return $this -> title ;
}
2013-04-18 14:11:06 +00:00
public function getAuthors () {
return $this -> author ;
}
public function getLanguage () {
return $this -> language ;
}
public function getDate () {
return $this -> date ;
}
2011-11-04 17:40:29 +00:00
public function getSiteConfig () {
return $this -> config ;
}
2014-05-15 20:49:16 +00:00
public function getNextPageUrl () {
return $this -> nextPageUrl ;
}
2014-05-15 21:03:31 +00:00
}