src/Content/OEmbed.php

   1 <?php
   2
   3 /**
   4  * @file src/Content/OEmbed.php
   5  */
   6
   7 namespace Friendica\Content;
   8
   9 use Friendica\Core\Cache;
  10 use Friendica\Core\System;
  11 use Friendica\Core\Config;
  12 use Friendica\Database\DBM;
  13 use Friendica\Util\ParseUrl;
  14 use dba;
  15 use DOMDocument;
  16 use DOMXPath;
  17 use DOMNode;
  18 use Exception;
  19
  20 require_once 'include/dba.php';
  21 require_once 'mod/proxy.php';
  22
  23 /**
  24  * Handles all OEmbed content fetching and replacement
  25  *
  26  * OEmbed is a standard used to allow an embedded representation of a URL on
  27  * third party sites
  28  *
  29  * @see https://oembed.com
  30  *
  31  * @author Hypolite Petovan <mrpetovan@gmail.com>
  32  */
  33 class OEmbed
  34 {
  35         public static function replaceCallback($matches)
  36         {
  37                 $embedurl = $matches[1];
  38                 $j = self::fetchURL($embedurl);
  39                 $s = self::formatObject($j);
  40
  41                 return $s;
  42         }
  43
  44         /**
  45          * @brief Get data from an URL to embed its content.
  46          *
  47          * @param string $embedurl The URL from which the data should be fetched.
  48          * @param bool $no_rich_type If set to true rich type content won't be fetched.
  49          *
  50          * @return bool|object Returns object with embed content or false if no embeddable
  51          *                         content exists
  52          */
  53         public static function fetchURL($embedurl, $no_rich_type = false)
  54         {
  55                 $embedurl = trim($embedurl, "'");
  56                 $embedurl = trim($embedurl, '"');
  57
  58                 $a = get_app();
  59
  60                 $condition = ['url' => normalise_link($embedurl), 'maxwidth' => $a->videowidth];
  61                 $r = dba::selectFirst('oembed', ['content'], $condition);
  62                 if (DBM::is_result($r)) {
  63                         $txt = $r["content"];
  64                 } else {
  65                         $txt = Cache::get($a->videowidth . $embedurl);
  66                 }
  67                 // These media files should now be caught in bbcode.php
  68                 // left here as a fallback in case this is called from another source
  69
  70                 $noexts = array("mp3", "mp4", "ogg", "ogv", "oga", "ogm", "webm");
  71                 $ext = pathinfo(strtolower($embedurl), PATHINFO_EXTENSION);
  72
  73
  74                 if (is_null($txt)) {
  75                         $txt = "";
  76
  77                         if (!in_array($ext, $noexts)) {
  78                                 // try oembed autodiscovery
  79                                 $redirects = 0;
  80                                 $html_text = fetch_url($embedurl, false, $redirects, 15, "text/*");
  81                                 if ($html_text) {
  82                                         $dom = @DOMDocument::loadHTML($html_text);
  83                                         if ($dom) {
  84                                                 $xpath = new DOMXPath($dom);
  85                                                 $entries = $xpath->query("//link[@type='application/json+oembed']");
  86                                                 foreach ($entries as $e) {
  87                                                         $href = $e->getAttributeNode("href")->nodeValue;
  88                                                         $txt = fetch_url($href . '&maxwidth=' . $a->videowidth);
  89                                                         break;
  90                                                 }
  91                                                 $entries = $xpath->query("//link[@type='text/json+oembed']");
  92                                                 foreach ($entries as $e) {
  93                                                         $href = $e->getAttributeNode("href")->nodeValue;
  94                                                         $txt = fetch_url($href . '&maxwidth=' . $a->videowidth);
  95                                                         break;
  96                                                 }
  97                                         }
  98                                 }
  99                         }
 100
 101                         $txt = trim($txt);
 102
 103                         if (!$txt || $txt[0] != "{") {
 104                                 $txt = '{"type":"error"}';
 105                         } else { //save in cache
 106                                 $j = json_decode($txt);
 107                                 if ($j->type != "error") {
 108                                         dba::insert('oembed', [
 109                                                 'url' => normalise_link($embedurl),
 110                                                 'maxwidth' => $a->videowidth,
 111                                                 'content' => $txt,
 112                                                 'created' => datetime_convert()
 113                                         ], true);
 114                                 }
 115
 116                                 Cache::set($a->videowidth . $embedurl, $txt, CACHE_DAY);
 117                         }
 118                 }
 119
 120                 $j = json_decode($txt);
 121
 122                 if (!is_object($j)) {
 123                         return false;
 124                 }
 125
 126                 // Always embed the SSL version
 127                 if (isset($j->html)) {
 128                         $j->html = str_replace(array("http://www.youtube.com/", "http://player.vimeo.com/"), array("https://www.youtube.com/", "https://player.vimeo.com/"), $j->html);
 129                 }
 130
 131                 $j->embedurl = $embedurl;
 132
 133                 // If fetching information doesn't work, then improve via internal functions
 134                 if (($j->type == "error") || ($no_rich_type && ($j->type == "rich"))) {
 135                         $data = ParseUrl::getSiteinfoCached($embedurl, true, false);
 136                         $j->type = $data["type"];
 137
 138                         if ($j->type == "photo") {
 139                                 $j->url = $data["url"];
 140                                 //$j->width = $data["images"][0]["width"];
 141                                 //$j->height = $data["images"][0]["height"];
 142                         }
 143
 144                         if (isset($data["title"])) {
 145                                 $j->title = $data["title"];
 146                         }
 147
 148                         if (isset($data["text"])) {
 149                                 $j->description = $data["text"];
 150                         }
 151
 152                         if (is_array($data["images"])) {
 153                                 $j->thumbnail_url = $data["images"][0]["src"];
 154                                 $j->thumbnail_width = $data["images"][0]["width"];
 155                                 $j->thumbnail_height = $data["images"][0]["height"];
 156                         }
 157                 }
 158
 159                 call_hooks('oembed_fetch_url', $embedurl, $j);
 160
 161                 return $j;
 162         }
 163
 164         public static function formatObject($j)
 165         {
 166                 $embedurl = $j->embedurl;
 167                 $jhtml = $j->html;
 168                 $ret = '<div class="oembed ' . $j->type . '">';
 169                 switch ($j->type) {
 170                         case "video":
 171                                 if (isset($j->thumbnail_url)) {
 172                                         $tw = (isset($j->thumbnail_width) && intval($j->thumbnail_width)) ? $j->thumbnail_width : 200;
 173                                         $th = (isset($j->thumbnail_height) && intval($j->thumbnail_height)) ? $j->thumbnail_height : 180;
 174                                         // make sure we don't attempt divide by zero, fallback is a 1:1 ratio
 175                                         $tr = (($th) ? $tw / $th : 1);
 176
 177                                         $th = 120;
 178                                         $tw = $th * $tr;
 179                                         $tpl = get_markup_template('oembed_video.tpl');
 180                                         $ret .= replace_macros($tpl, array(
 181                                                 '$baseurl' => System::baseUrl(),
 182                                                 '$embedurl' => $embedurl,
 183                                                 '$escapedhtml' => base64_encode($jhtml),
 184                                                 '$tw' => $tw,
 185                                                 '$th' => $th,
 186                                                 '$turl' => $j->thumbnail_url,
 187                                         ));
 188                                 } else {
 189                                         $ret = $jhtml;
 190                                 }
 191                                 break;
 192                         case "photo":
 193                                 $ret .= '<img width="' . $j->width . '" src="' . proxy_url($j->url) . '">';
 194                                 break;
 195                         case "link":
 196                                 break;
 197                         case "rich":
 198                                 if (self::isAllowedURL($embedurl)) {
 199                                         $ret .= proxy_parse_html($jhtml);
 200                                 }
 201                                 break;
 202                 }
 203
 204                 $ret .= '</div>';
 205                 // add link to source if not present in "rich" type
 206                 if ($j->type != 'rich' || !strpos($j->html, $embedurl)) {
 207                         $ret .= '<h4>';
 208                         if (isset($j->title)) {
 209                                 if (isset($j->provider_name)) {
 210                                         $ret .= $j->provider_name . ": ";
 211                                 }
 212
 213                                 $embedlink = (isset($j->title)) ? $j->title : $embedurl;
 214                                 $ret .= '<a href="' . $embedurl . '" rel="oembed">' . $embedlink . '</a>';
 215                                 if (isset($j->author_name)) {
 216                                         $ret .= ' (' . $j->author_name . ')';
 217                                 }
 218                         } elseif (isset($j->provider_name) || isset($j->author_name)) {
 219                                 $embedlink = "";
 220                                 if (isset($j->provider_name)) {
 221                                         $embedlink .= $j->provider_name;
 222                                 }
 223
 224                                 if (isset($j->author_name)) {
 225                                         if ($embedlink != "") {
 226                                                 $embedlink .= ": ";
 227                                         }
 228
 229                                         $embedlink .= $j->author_name;
 230                                 }
 231                                 if (trim($embedlink) == "") {
 232                                         $embedlink = $embedurl;
 233                                 }
 234
 235                                 $ret .= '<a href="' . $embedurl . '" rel="oembed">' . $embedlink . '</a>';
 236                         }
 237                         $ret .= "</h4>";
 238                 } elseif (!strpos($j->html, $embedurl)) {
 239                         // add <a> for html2bbcode conversion
 240                         $ret .= '<a href="' . $embedurl . '" rel="oembed">' . $j->title . '</a>';
 241                 }
 242
 243                 $ret = str_replace("\n", "", $ret);
 244                 return mb_convert_encoding($ret, 'HTML-ENTITIES', mb_detect_encoding($ret));
 245         }
 246
 247         public static function BBCode2HTML($text)
 248         {
 249                 $stopoembed = Config::get("system", "no_oembed");
 250                 if ($stopoembed == true) {
 251                         return preg_replace("/\[embed\](.+?)\[\/embed\]/is", "<!-- oembed $1 --><i>" . t('Embedding disabled') . " : $1</i><!-- /oembed $1 -->", $text);
 252                 }
 253                 return preg_replace_callback("/\[embed\](.+?)\[\/embed\]/is", ['self', 'replaceCallback'], $text);
 254         }
 255
 256         /**
 257          * Find <span class='oembed'>..<a href='url' rel='oembed'>..</a></span>
 258          * and replace it with [embed]url[/embed]
 259          */
 260         public static function HTML2BBCode($text)
 261         {
 262                 // start parser only if 'oembed' is in text
 263                 if (strpos($text, "oembed")) {
 264
 265                         // convert non ascii chars to html entities
 266                         $html_text = mb_convert_encoding($text, 'HTML-ENTITIES', mb_detect_encoding($text));
 267
 268                         // If it doesn't parse at all, just return the text.
 269                         $dom = @DOMDocument::loadHTML($html_text);
 270                         if (!$dom) {
 271                                 return $text;
 272                         }
 273                         $xpath = new DOMXPath($dom);
 274
 275                         $xattr = self::buildXPath("class", "oembed");
 276                         $entries = $xpath->query("//div[$xattr]");
 277
 278                         $xattr = "@rel='oembed'"; //oe_build_xpath("rel","oembed");
 279                         foreach ($entries as $e) {
 280                                 $href = $xpath->evaluate("a[$xattr]/@href", $e)->item(0)->nodeValue;
 281                                 if (!is_null($href)) {
 282                                         $e->parentNode->replaceChild(new DOMText("[embed]" . $href . "[/embed]"), $e);
 283                                 }
 284                         }
 285                         return self::getInnerHTML($dom->getElementsByTagName("body")->item(0));
 286                 } else {
 287                         return $text;
 288                 }
 289         }
 290
 291         /**
 292          * Determines if rich content OEmbed is allowed for the provided URL
 293          *
 294          * @brief Determines if rich content OEmbed is allowed for the provided URL
 295          * @param string $url
 296          * @return boolean
 297          */
 298         public static function isAllowedURL($url)
 299         {
 300                 if (!Config::get('system', 'no_oembed_rich_content')) {
 301                         return true;
 302                 }
 303
 304                 $domain = parse_url($url, PHP_URL_HOST);
 305                 if (!x($domain)) {
 306                         return false;
 307                 }
 308
 309                 $str_allowed = Config::get('system', 'allowed_oembed', '');
 310                 if (!x($str_allowed)) {
 311                         return false;
 312                 }
 313
 314                 $allowed = explode(',', $str_allowed);
 315
 316                 return allowed_domain($domain, $allowed);
 317         }
 318
 319         public static function getHTML($url, $title = null)
 320         {
 321                 // Always embed the SSL version
 322                 $url = str_replace(array("http://www.youtube.com/", "http://player.vimeo.com/"),
 323                                         array("https://www.youtube.com/", "https://player.vimeo.com/"), $url);
 324
 325                 $o = OEmbed::fetchURL($url);
 326
 327                 if (!is_object($o) || $o->type == 'error') {
 328                         throw new Exception('OEmbed failed for URL: ' . $url);
 329                 }
 330
 331                 if (x($title)) {
 332                         $o->title = $title;
 333                 }
 334
 335                 $html = OEmbed::formatObject($o);
 336
 337                 return $html;
 338         }
 339
 340         /**
 341          * @brief Generates the iframe HTML for an oembed attachment.
 342          *
 343          * Width and height are given by the remote, and are regularly too small for
 344          * the generated iframe.
 345          *
 346          * The width is entirely discarded for the actual width of the post, while fixed
 347          * height is used as a starting point before the inevitable resizing.
 348          *
 349          * Since the iframe is automatically resized on load, there are no need for ugly
 350          * and impractical scrollbars.
 351          *
 352          * @todo This function is currently unused until someone™ adds support for a separate OEmbed domain
 353          *
 354          * @param string $src Original remote URL to embed
 355          * @param string $width
 356          * @param string $height
 357          * @return string formatted HTML
 358          *
 359          * @see oembed_format_object()
 360          */
 361         private static function iframe($src, $width, $height)
 362         {
 363                 $a = get_app();
 364
 365                 if (!$height || strstr($height, '%')) {
 366                         $height = '200';
 367                 }
 368                 $width = '100%';
 369
 370                 $src = System::baseUrl() . '/oembed/' . base64url_encode($src);
 371                 return '<iframe onload="resizeIframe(this);" class="embed_rich" height="' . $height . '" width="' . $width . '" src="' . $src . '" allowfullscreen scrolling="no" frameborder="no">' . t('Embedded content') . '</iframe>';
 372         }
 373
 374         /**
 375          * Generates an XPath query to select elements whose provided attribute contains
 376          * the provided value in a space-separated list.
 377          *
 378          * @brief Generates attribute search XPath string
 379          *
 380          * @param string $attr Name of the attribute to seach
 381          * @param string $value Value to search in a space-separated list
 382          * @return string
 383          */
 384         private static function buildXPath($attr, $value)
 385         {
 386                 // https://www.westhoffswelt.de/blog/2009/6/9/select-html-elements-with-more-than-one-css-class-using-xpath
 387                 return "contains(normalize-space(@$attr), ' $value ') or substring(normalize-space(@$attr), 1, string-length('$value') + 1) = '$value ' or substring(normalize-space(@$attr), string-length(@$attr) - string-length('$value')) = ' $value' or @$attr = '$value'";
 388         }
 389
 390         /**
 391          * Returns the inner XML string of a provided DOMNode
 392          *
 393          * @brief Returns the inner XML string of a provided DOMNode
 394          *
 395          * @param DOMNode $node
 396          * @return string
 397          */
 398         private static function getInnerHTML(DOMNode $node)
 399         {
 400                 $innerHTML = '';
 401                 $children = $node->childNodes;
 402                 foreach ($children as $child) {
 403                         $innerHTML .= $child->ownerDocument->saveXML($child);
 404                 }
 405                 return $innerHTML;
 406         }
 407
 408 }