src/Util/ParseUrl.php

   1 <?php
   2 /**
   3  * @file src/Util/ParseUrl.php
   4  * @brief Get informations about a given URL
   5  */
   6 namespace Friendica\Util;
   7
   8 use DOMDocument;
   9 use DOMXPath;
  10 use Friendica\Content\OEmbed;
  11 use Friendica\Core\Addon;
  12 use Friendica\Database\DBA;
  13 use Friendica\Object\Image;
  14
  15 require_once 'include/dba.php';
  16
  17 /**
  18  * @brief Class with methods for extracting certain content from an url
  19  */
  20 class ParseUrl
  21 {
  22         /**
  23          * @brief Search for chached embeddable data of an url otherwise fetch it
  24          *
  25          * @param string $url         The url of the page which should be scraped
  26          * @param bool $no_guessing If true the parse doens't search for
  27          *                          preview pictures
  28          * @param bool $do_oembed   The false option is used by the function fetch_oembed()
  29          *                          to avoid endless loops
  30          *
  31          * @return array which contains needed data for embedding
  32          *    string 'url' => The url of the parsed page
  33          *    string 'type' => Content type
  34          *    string 'title' => The title of the content
  35          *    string 'text' => The description for the content
  36          *    string 'image' => A preview image of the content (only available
  37          *                if $no_geuessing = false
  38          *    array'images' = Array of preview pictures
  39          *    string 'keywords' => The tags which belong to the content
  40          *
  41          * @see ParseUrl::getSiteinfo() for more information about scraping
  42          * embeddable content
  43          */
  44         public static function getSiteinfoCached($url, $no_guessing = false, $do_oembed = true)
  45         {
  46                 if ($url == "") {
  47                         return false;
  48                 }
  49
  50                 $parsed_url = DBA::selectFirst('parsed_url', ['content'],
  51                         ['url' => normalise_link($url), 'guessing' => !$no_guessing, 'oembed' => $do_oembed]
  52                 );
  53                 if (!empty($parsed_url['content'])) {
  54                         $data = unserialize($parsed_url['content']);
  55                         return $data;
  56                 }
  57
  58                 $data = self::getSiteinfo($url, $no_guessing, $do_oembed);
  59
  60                 DBA::insert(
  61                         'parsed_url',
  62                         [
  63                                 'url' => normalise_link($url), 'guessing' => !$no_guessing,
  64                                 'oembed' => $do_oembed, 'content' => serialize($data),
  65                                 'created' => DateTimeFormat::utcNow()
  66                         ],
  67                         true
  68                 );
  69
  70                 return $data;
  71         }
  72         /**
  73          * @brief Parse a page for embeddable content information
  74          *
  75          * This method parses to url for meta data which can be used to embed
  76          * the content. If available it prioritizes Open Graph meta tags.
  77          * If this is not available it uses the twitter cards meta tags.
  78          * As fallback it uses standard html elements with meta informations
  79          * like \<title\>Awesome Title\</title\> or
  80          * \<meta name="description" content="An awesome description"\>
  81          *
  82          * @param string $url         The url of the page which should be scraped
  83          * @param bool $no_guessing If true the parse doens't search for
  84          *                          preview pictures
  85          * @param bool $do_oembed   The false option is used by the function fetch_oembed()
  86          *                          to avoid endless loops
  87          * @param int $count       Internal counter to avoid endless loops
  88          *
  89          * @return array which contains needed data for embedding
  90          *    string 'url' => The url of the parsed page
  91          *    string 'type' => Content type
  92          *    string 'title' => The title of the content
  93          *    string 'text' => The description for the content
  94          *    string 'image' => A preview image of the content (only available
  95          *                if $no_geuessing = false
  96          *    array'images' = Array of preview pictures
  97          *    string 'keywords' => The tags which belong to the content
  98          *
  99          * @todo https://developers.google.com/+/plugins/snippet/
 100          * @verbatim
 101          * <meta itemprop="name" content="Awesome title">
 102          * <meta itemprop="description" content="An awesome description">
 103          * <meta itemprop="image" content="http://maple.libertreeproject.org/images/tree-icon.png">
 104          *
 105          * <body itemscope itemtype="http://schema.org/Product">
 106          *   <h1 itemprop="name">Shiny Trinket</h1>
 107          *   <img itemprop="image" src="{image-url}" />
 108          *   <p itemprop="description">Shiny trinkets are shiny.</p>
 109          * </body>
 110          * @endverbatim
 111          */
 112         public static function getSiteinfo($url, $no_guessing = false, $do_oembed = true, $count = 1)
 113         {
 114                 $a = get_app();
 115
 116                 $siteinfo = [];
 117
 118                 // Check if the URL does contain a scheme
 119                 $scheme = parse_url($url, PHP_URL_SCHEME);
 120
 121                 if ($scheme == '') {
 122                         $url = 'http://' . trim($url, '/');
 123                 }
 124
 125                 if ($count > 10) {
 126                         logger('Endless loop detected for ' . $url, LOGGER_DEBUG);
 127                         return $siteinfo;
 128                 }
 129
 130                 $url = trim($url, "'");
 131                 $url = trim($url, '"');
 132
 133                 $url = Network::stripTrackingQueryParams($url);
 134
 135                 $siteinfo['url'] = $url;
 136                 $siteinfo['type'] = 'link';
 137
 138                 $data = Network::curl($url);
 139                 if (!$data['success']) {
 140                         return $siteinfo;
 141                 }
 142
 143                 // If the file is too large then exit
 144                 if ($data['info']['download_content_length'] > 1000000) {
 145                         return $siteinfo;
 146                 }
 147
 148                 // If it isn't a HTML file then exit
 149                 if (($data['info']['content_type'] != '') && !strstr(strtolower($data['info']['content_type']), 'html')) {
 150                         return $siteinfo;
 151                 }
 152
 153                 $header = $data['header'];
 154                 $body = $data['body'];
 155
 156                 if ($do_oembed) {
 157                         $oembed_data = OEmbed::fetchURL($url);
 158
 159                         if (!empty($oembed_data->type)) {
 160                                 if (!in_array($oembed_data->type, ['error', 'rich', ''])) {
 161                                         $siteinfo['type'] = $oembed_data->type;
 162                                 }
 163
 164                                 if (isset($oembed_data->title)) {
 165                                         $siteinfo['title'] = trim($oembed_data->title);
 166                                 }
 167                                 if (isset($oembed_data->description)) {
 168                                         $siteinfo['text'] = trim($oembed_data->description);
 169                                 }
 170                                 if (isset($oembed_data->thumbnail_url)) {
 171                                         $siteinfo['image'] = $oembed_data->thumbnail_url;
 172                                 }
 173                         }
 174                 }
 175
 176                 // Fetch the first mentioned charset. Can be in body or header
 177                 $charset = '';
 178                 if (preg_match('/charset=(.*?)[\'"\s\n]/', $header, $matches)) {
 179                         $charset = trim(trim(trim(array_pop($matches)), ';,'));
 180                 }
 181
 182                 if ($charset == '') {
 183                         $charset = 'utf-8';
 184                 }
 185
 186                 if (($charset != '') && (strtoupper($charset) != 'UTF-8')) {
 187                         logger('detected charset ' . $charset, LOGGER_DEBUG);
 188                         $body = iconv($charset, 'UTF-8//TRANSLIT', $body);
 189                 }
 190
 191                 $body = mb_convert_encoding($body, 'HTML-ENTITIES', 'UTF-8');
 192
 193                 $doc = new DOMDocument();
 194                 @$doc->loadHTML($body);
 195
 196                 XML::deleteNode($doc, 'style');
 197                 XML::deleteNode($doc, 'script');
 198                 XML::deleteNode($doc, 'option');
 199                 XML::deleteNode($doc, 'h1');
 200                 XML::deleteNode($doc, 'h2');
 201                 XML::deleteNode($doc, 'h3');
 202                 XML::deleteNode($doc, 'h4');
 203                 XML::deleteNode($doc, 'h5');
 204                 XML::deleteNode($doc, 'h6');
 205                 XML::deleteNode($doc, 'ol');
 206                 XML::deleteNode($doc, 'ul');
 207
 208                 $xpath = new DOMXPath($doc);
 209
 210                 $list = $xpath->query('//meta[@content]');
 211                 foreach ($list as $node) {
 212                         $meta_tag = [];
 213                         if ($node->attributes->length) {
 214                                 foreach ($node->attributes as $attribute) {
 215                                         $meta_tag[$attribute->name] = $attribute->value;
 216                                 }
 217                         }
 218
 219                         if (@$meta_tag['http-equiv'] == 'refresh') {
 220                                 $path = $meta_tag['content'];
 221                                 $pathinfo = explode(';', $path);
 222                                 $content = '';
 223                                 foreach ($pathinfo as $value) {
 224                                         if (substr(strtolower($value), 0, 4) == 'url=') {
 225                                                 $content = substr($value, 4);
 226                                         }
 227                                 }
 228                                 if ($content != '') {
 229                                         $siteinfo = self::getSiteinfo($content, $no_guessing, $do_oembed, ++$count);
 230                                         return $siteinfo;
 231                                 }
 232                         }
 233                 }
 234
 235                 $list = $xpath->query('//title');
 236                 if ($list->length > 0) {
 237                         $siteinfo['title'] = trim($list->item(0)->nodeValue);
 238                 }
 239
 240                 $list = $xpath->query('//meta[@name]');
 241                 foreach ($list as $node) {
 242                         $meta_tag = [];
 243                         if ($node->attributes->length) {
 244                                 foreach ($node->attributes as $attribute) {
 245                                         $meta_tag[$attribute->name] = $attribute->value;
 246                                 }
 247                         }
 248
 249                         if (empty($meta_tag['content'])) {
 250                                 continue;
 251                         }
 252
 253                         $meta_tag['content'] = trim(html_entity_decode($meta_tag['content'], ENT_QUOTES, 'UTF-8'));
 254
 255                         switch (strtolower($meta_tag['name'])) {
 256                                 case 'fulltitle':
 257                                         $siteinfo['title'] = trim($meta_tag['content']);
 258                                         break;
 259                                 case 'description':
 260                                         $siteinfo['text'] = trim($meta_tag['content']);
 261                                         break;
 262                                 case 'thumbnail':
 263                                         $siteinfo['image'] = $meta_tag['content'];
 264                                         break;
 265                                 case 'twitter:image':
 266                                         $siteinfo['image'] = $meta_tag['content'];
 267                                         break;
 268                                 case 'twitter:image:src':
 269                                         $siteinfo['image'] = $meta_tag['content'];
 270                                         break;
 271                                 case 'twitter:card':
 272                                         // Detect photo pages
 273                                         if ($meta_tag['content'] == 'summary_large_image') {
 274                                                 $siteinfo['type'] = 'photo';
 275                                         }
 276                                         break;
 277                                 case 'twitter:description':
 278                                         $siteinfo['text'] = trim($meta_tag['content']);
 279                                         break;
 280                                 case 'twitter:title':
 281                                         $siteinfo['title'] = trim($meta_tag['content']);
 282                                         break;
 283                                 case 'dc.title':
 284                                         $siteinfo['title'] = trim($meta_tag['content']);
 285                                         break;
 286                                 case 'dc.description':
 287                                         $siteinfo['text'] = trim($meta_tag['content']);
 288                                         break;
 289                                 case 'keywords':
 290                                         $keywords = explode(',', $meta_tag['content']);
 291                                         break;
 292                                 case 'news_keywords':
 293                                         $keywords = explode(',', $meta_tag['content']);
 294                                         break;
 295                         }
 296                 }
 297
 298                 if (isset($keywords)) {
 299                         $siteinfo['keywords'] = [];
 300                         foreach ($keywords as $keyword) {
 301                                 if (!in_array(trim($keyword), $siteinfo['keywords'])) {
 302                                         $siteinfo['keywords'][] = trim($keyword);
 303                                 }
 304                         }
 305                 }
 306
 307                 $list = $xpath->query('//meta[@property]');
 308                 foreach ($list as $node) {
 309                         $meta_tag = [];
 310                         if ($node->attributes->length) {
 311                                 foreach ($node->attributes as $attribute) {
 312                                         $meta_tag[$attribute->name] = $attribute->value;
 313                                 }
 314                         }
 315
 316                         if (!empty($meta_tag['content'])) {
 317                                 $meta_tag['content'] = trim(html_entity_decode($meta_tag['content'], ENT_QUOTES, 'UTF-8'));
 318
 319                                 switch (strtolower($meta_tag['property'])) {
 320                                         case 'og:image':
 321                                                 $siteinfo['image'] = $meta_tag['content'];
 322                                                 break;
 323                                         case 'og:title':
 324                                                 $siteinfo['title'] = trim($meta_tag['content']);
 325                                                 break;
 326                                         case 'og:description':
 327                                                 $siteinfo['text'] = trim($meta_tag['content']);
 328                                                 break;
 329                                 }
 330                         }
 331                 }
 332
 333                 // Prevent to have a photo type without an image
 334                 if ((empty($siteinfo['image']) || !empty($siteinfo['text'])) && ($siteinfo['type'] == 'photo')) {
 335                         $siteinfo['type'] = 'link';
 336                 }
 337
 338                 if (empty($siteinfo['image']) && !$no_guessing) {
 339                         $list = $xpath->query('//img[@src]');
 340                         foreach ($list as $node) {
 341                                 $img_tag = [];
 342                                 if ($node->attributes->length) {
 343                                         foreach ($node->attributes as $attribute) {
 344                                                 $img_tag[$attribute->name] = $attribute->value;
 345                                         }
 346                                 }
 347
 348                                 $src = self::completeUrl($img_tag['src'], $url);
 349                                 $photodata = Image::getInfoFromURL($src);
 350
 351                                 if (($photodata) && ($photodata[0] > 150) && ($photodata[1] > 150)) {
 352                                         if ($photodata[0] > 300) {
 353                                                 $photodata[1] = round($photodata[1] * (300 / $photodata[0]));
 354                                                 $photodata[0] = 300;
 355                                         }
 356                                         if ($photodata[1] > 300) {
 357                                                 $photodata[0] = round($photodata[0] * (300 / $photodata[1]));
 358                                                 $photodata[1] = 300;
 359                                         }
 360                                         $siteinfo['images'][] = [
 361                                                 'src'    => $src,
 362                                                 'width'  => $photodata[0],
 363                                                 'height' => $photodata[1]
 364                                         ];
 365                                 }
 366                         }
 367                 } elseif (!empty($siteinfo['image'])) {
 368                         $src = self::completeUrl($siteinfo['image'], $url);
 369
 370                         unset($siteinfo['image']);
 371
 372                         $photodata = Image::getInfoFromURL($src);
 373
 374                         if (($photodata) && ($photodata[0] > 10) && ($photodata[1] > 10)) {
 375                                 $siteinfo['images'][] = ['src' => $src,
 376                                         'width' => $photodata[0],
 377                                         'height' => $photodata[1]];
 378                         }
 379                 }
 380
 381                 if ((@$siteinfo['text'] == '') && (@$siteinfo['title'] != '') && !$no_guessing) {
 382                         $text = '';
 383
 384                         $list = $xpath->query('//div[@class="article"]');
 385                         foreach ($list as $node) {
 386                                 if (strlen($node->nodeValue) > 40) {
 387                                         $text .= ' ' . trim($node->nodeValue);
 388                                 }
 389                         }
 390
 391                         if ($text == '') {
 392                                 $list = $xpath->query('//div[@class="content"]');
 393                                 foreach ($list as $node) {
 394                                         if (strlen($node->nodeValue) > 40) {
 395                                                 $text .= ' ' . trim($node->nodeValue);
 396                                         }
 397                                 }
 398                         }
 399
 400                         // If none text was found then take the paragraph content
 401                         if ($text == '') {
 402                                 $list = $xpath->query('//p');
 403                                 foreach ($list as $node) {
 404                                         if (strlen($node->nodeValue) > 40) {
 405                                                 $text .= ' ' . trim($node->nodeValue);
 406                                         }
 407                                 }
 408                         }
 409
 410                         if ($text != '') {
 411                                 $text = trim(str_replace(["\n", "\r"], [' ', ' '], $text));
 412
 413                                 while (strpos($text, '  ')) {
 414                                         $text = trim(str_replace('  ', ' ', $text));
 415                                 }
 416
 417                                 $siteinfo['text'] = trim(html_entity_decode(substr($text, 0, 350), ENT_QUOTES, 'UTF-8') . '...');
 418                         }
 419                 }
 420
 421                 logger('Siteinfo for ' . $url . ' ' . print_r($siteinfo, true), LOGGER_DEBUG);
 422
 423                 Addon::callHooks('getsiteinfo', $siteinfo);
 424
 425                 return $siteinfo;
 426         }
 427
 428         /**
 429          * @brief Convert tags from CSV to an array
 430          *
 431          * @param string $string Tags
 432          * @return array with formatted Hashtags
 433          */
 434         public static function convertTagsToArray($string)
 435         {
 436                 $arr_tags = str_getcsv($string);
 437                 if (count($arr_tags)) {
 438                         // add the # sign to every tag
 439                         array_walk($arr_tags, ["self", "arrAddHashes"]);
 440
 441                         return $arr_tags;
 442                 }
 443         }
 444
 445         /**
 446          * @brief Add a hasht sign to a string
 447          *
 448          *  This method is used as callback function
 449          *
 450          * @param string $tag The pure tag name
 451          * @param int    $k   Counter for internal use
 452          * @return void
 453          */
 454         private static function arrAddHashes(&$tag, $k)
 455         {
 456                 $tag = "#" . $tag;
 457         }
 458
 459         /**
 460          * @brief Add a scheme to an url
 461          *
 462          * The src attribute of some html elements (e.g. images)
 463          * can miss the scheme so we need to add the correct
 464          * scheme
 465          *
 466          * @param string $url    The url which possibly does have
 467          *                       a missing scheme (a link to an image)
 468          * @param string $scheme The url with a correct scheme
 469          *                       (e.g. the url from the webpage which does contain the image)
 470          *
 471          * @return string The url with a scheme
 472          */
 473         private static function completeUrl($url, $scheme)
 474         {
 475                 $urlarr = parse_url($url);
 476
 477                 // If the url does allready have an scheme
 478                 // we can stop the process here
 479                 if (isset($urlarr["scheme"])) {
 480                         return($url);
 481                 }
 482
 483                 $schemearr = parse_url($scheme);
 484
 485                 $complete = $schemearr["scheme"]."://".$schemearr["host"];
 486
 487                 if (@$schemearr["port"] != "") {
 488                         $complete .= ":".$schemearr["port"];
 489                 }
 490
 491                 if (strpos($urlarr["path"], "/") !== 0) {
 492                         $complete .= "/";
 493                 }
 494
 495                 $complete .= $urlarr["path"];
 496
 497                 if (@$urlarr["query"] != "") {
 498                         $complete .= "?".$urlarr["query"];
 499                 }
 500
 501                 if (@$urlarr["fragment"] != "") {
 502                         $complete .= "#".$urlarr["fragment"];
 503                 }
 504
 505                 return($complete);
 506         }
 507 }