plugins/Oembed/OembedPlugin.php

   1 <?php
   2
   3 if (!defined('GNUSOCIAL')) { exit(1); }
   4
   5 class OembedPlugin extends Plugin
   6 {
   7     // settings which can be set in config.php with addPlugin('Oembed', array('param'=>'value', ...));
   8     // WARNING, these are _regexps_ (slashes added later). Always escape your dots and end your strings
   9     public $domain_whitelist = array(       // hostname => service provider
  10                                     '^i\d*\.ytimg\.com$' => 'YouTube',
  11                                     '^i\d*\.vimeocdn\.com$' => 'Vimeo',
  12                                     );
  13     public $append_whitelist = array(); // fill this array as domain_whitelist to add more trusted sources
  14     public $check_whitelist  = false;    // security/abuse precaution
  15
  16     protected $imgData = array();
  17
  18     // these should be declared protected everywhere
  19     public function initialize()
  20     {
  21         parent::initialize();
  22
  23         $this->domain_whitelist = array_merge($this->domain_whitelist, $this->append_whitelist);
  24     }
  25
  26     public function onCheckSchema()
  27     {
  28         $schema = Schema::get();
  29         $schema->ensureTable('file_oembed', File_oembed::schemaDef());
  30         return true;
  31     }
  32
  33     public function onRouterInitialized(URLMapper $m)
  34     {
  35         $m->connect('main/oembed', array('action' => 'oembed'));
  36     }
  37
  38     public function onGetRemoteUrlMetadataFromDom($url, DOMDocument $dom, stdClass &$metadata)
  39     {
  40         try {
  41             common_log(LOG_INFO, 'Trying to discover an oEmbed endpoint using link headers.');
  42             $api = oEmbedHelper::oEmbedEndpointFromHTML($dom);
  43             common_log(LOG_INFO, 'Found oEmbed API endpoint ' . $api . ' for URL ' . $url);
  44             $params = array(
  45                 'maxwidth' => common_config('thumbnail', 'width'),
  46                 'maxheight' => common_config('thumbnail', 'height'),
  47             );
  48             $metadata = oEmbedHelper::getOembedFrom($api, $url, $params);
  49
  50             // Facebook just gives us javascript in its oembed html,
  51             // so use the content of the title element instead
  52             if(strpos($url,'https://www.facebook.com/') === 0) {
  53               $metadata->html = @$dom->getElementsByTagName('title')->item(0)->nodeValue;
  54             }
  55
  56             // Wordpress sometimes also just gives us javascript, use og:description if it is available
  57             $xpath = new DomXpath($dom);
  58             $generatorNode = @$xpath->query('//meta[@name="generator"][1]')->item(0);
  59             if ($generatorNode instanceof DomElement) {
  60                 // when wordpress only gives us javascript, the html stripped from tags
  61                 // is the same as the title, so this helps us to identify this (common) case
  62                 if(strpos($generatorNode->getAttribute('content'),'WordPress') === 0
  63                 && trim(strip_tags($metadata->html)) == trim($metadata->title)) {
  64                     $propertyNode = @$xpath->query('//meta[@property="og:description"][1]')->item(0);
  65                     if ($propertyNode instanceof DomElement) {
  66                         $metadata->html = $propertyNode->getAttribute('content');
  67                     }
  68                 }
  69             }
  70         } catch (Exception $e) {
  71             common_log(LOG_INFO, 'Could not find an oEmbed endpoint using link headers, trying OpenGraph from HTML.');
  72             // Just ignore it!
  73             $metadata = OpenGraphHelper::ogFromHtml($dom);
  74         }
  75
  76         if (isset($metadata->thumbnail_url)) {
  77             // sometimes sites serve the path, not the full URL, for images
  78             // let's "be liberal in what you accept from others"!
  79             // add protocol and host if the thumbnail_url starts with /
  80             if(substr($metadata->thumbnail_url,0,1) == '/') {
  81                 $thumbnail_url_parsed = parse_url($metadata->url);
  82                 $metadata->thumbnail_url = $thumbnail_url_parsed['scheme']."://".$thumbnail_url_parsed['host'].$metadata->thumbnail_url;
  83             }
  84
  85             // some wordpress opengraph implementations sometimes return a white blank image
  86             // no need for us to save that!
  87             if($metadata->thumbnail_url == 'https://s0.wp.com/i/blank.jpg') {
  88                 unset($metadata->thumbnail_url);
  89             }
  90         }
  91
  92     }
  93
  94     public function onEndShowHeadElements(Action $action)
  95     {
  96         switch ($action->getActionName()) {
  97         case 'attachment':
  98             $action->element('link',array('rel'=>'alternate',
  99                 'type'=>'application/json+oembed',
 100                 'href'=>common_local_url(
 101                     'oembed',
 102                     array(),
 103                     array('format'=>'json', 'url'=>
 104                         common_local_url('attachment',
 105                             array('attachment' => $action->attachment->id)))),
 106                 'title'=>'oEmbed'),null);
 107             $action->element('link',array('rel'=>'alternate',
 108                 'type'=>'text/xml+oembed',
 109                 'href'=>common_local_url(
 110                     'oembed',
 111                     array(),
 112                     array('format'=>'xml','url'=>
 113                         common_local_url('attachment',
 114                             array('attachment' => $action->attachment->id)))),
 115                 'title'=>'oEmbed'),null);
 116             break;
 117         case 'shownotice':
 118             if (!$action->notice->isLocal()) {
 119                 break;
 120             }
 121             try {
 122                 $action->element('link',array('rel'=>'alternate',
 123                     'type'=>'application/json+oembed',
 124                     'href'=>common_local_url(
 125                         'oembed',
 126                         array(),
 127                         array('format'=>'json','url'=>$action->notice->getUrl())),
 128                     'title'=>'oEmbed'),null);
 129                 $action->element('link',array('rel'=>'alternate',
 130                     'type'=>'text/xml+oembed',
 131                     'href'=>common_local_url(
 132                         'oembed',
 133                         array(),
 134                         array('format'=>'xml','url'=>$action->notice->getUrl())),
 135                     'title'=>'oEmbed'),null);
 136             } catch (InvalidUrlException $e) {
 137                 // The notice is probably a share or similar, which don't
 138                 // have a representational URL of their own.
 139             }
 140             break;
 141         }
 142
 143         return true;
 144     }
 145
 146     /**
 147      * Save embedding information for a File, if applicable.
 148      *
 149      * Normally this event is called through File::saveNew()
 150      *
 151      * @param File   $file       The newly inserted File object.
 152      *
 153      * @return boolean success
 154      */
 155     public function onEndFileSaveNew(File $file)
 156     {
 157         $fo = File_oembed::getKV('file_id', $file->id);
 158         if ($fo instanceof File_oembed) {
 159             common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file {$file->id}", __FILE__);
 160             return true;
 161         }
 162
 163         if (isset($file->mimetype)
 164             && (('text/html' === substr($file->mimetype, 0, 9)
 165             || 'application/xhtml+xml' === substr($file->mimetype, 0, 21)))) {
 166
 167             try {
 168                 $oembed_data = File_oembed::_getOembed($file->url);
 169                 if ($oembed_data === false) {
 170                     throw new Exception('Did not get oEmbed data from URL');
 171                 }
 172             } catch (Exception $e) {
 173                 return true;
 174             }
 175
 176             File_oembed::saveNew($oembed_data, $file->id);
 177         }
 178         return true;
 179     }
 180
 181     public function onEndShowAttachmentLink(HTMLOutputter $out, File $file)
 182     {
 183         $oembed = File_oembed::getKV('file_id', $file->id);
 184         if (empty($oembed->author_name) && empty($oembed->provider)) {
 185             return true;
 186         }
 187         $out->elementStart('div', array('id'=>'oembed_info', 'class'=>'e-content'));
 188         if (!empty($oembed->author_name)) {
 189             $out->elementStart('div', 'fn vcard author');
 190             if (empty($oembed->author_url)) {
 191                 $out->text($oembed->author_name);
 192             } else {
 193                 $out->element('a', array('href' => $oembed->author_url,
 194                                          'class' => 'url'),
 195                                 $oembed->author_name);
 196             }
 197         }
 198         if (!empty($oembed->provider)) {
 199             $out->elementStart('div', 'fn vcard');
 200             if (empty($oembed->provider_url)) {
 201                 $out->text($oembed->provider);
 202             } else {
 203                 $out->element('a', array('href' => $oembed->provider_url,
 204                                          'class' => 'url'),
 205                                 $oembed->provider);
 206             }
 207         }
 208         $out->elementEnd('div');
 209     }
 210
 211     public function onFileEnclosureMetadata(File $file, &$enclosure)
 212     {
 213         // Never treat generic HTML links as an enclosure type!
 214         // But if we have oEmbed info, we'll consider it golden.
 215         $oembed = File_oembed::getKV('file_id', $file->id);
 216         if (!$oembed instanceof File_oembed || !in_array($oembed->type, array('photo', 'video'))) {
 217             return true;
 218         }
 219
 220         foreach (array('mimetype', 'url', 'title', 'modified', 'width', 'height') as $key) {
 221             if (isset($oembed->{$key}) && !empty($oembed->{$key})) {
 222                 $enclosure->{$key} = $oembed->{$key};
 223             }
 224         }
 225         return true;
 226     }
 227
 228     public function onShowUnsupportedAttachmentRepresentation(HTMLOutputter $out, File $file)
 229     {
 230         try {
 231             $oembed = File_oembed::getByFile($file);
 232         } catch (NoResultException $e) {
 233             return true;
 234         }
 235
 236         // the 'photo' type is shown through ordinary means, using StartShowAttachmentRepresentation!
 237         switch ($oembed->type) {
 238         case 'video':
 239         case 'link':
 240             if (!empty($oembed->html)
 241                     && (GNUsocial::isAjax() || common_config('attachments', 'show_html'))) {
 242                 require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
 243                 $purifier = new HTMLPurifier();
 244                 // FIXME: do we allow <object> and <embed> here? we did that when we used htmLawed, but I'm not sure anymore...
 245                 $out->raw($purifier->purify($oembed->html));
 246             }
 247             return false;
 248             break;
 249         }
 250
 251         return true;
 252     }
 253
 254     public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
 255     {
 256         // If we are on a private node, we won't do any remote calls (just as a precaution until
 257         // we can configure this from config.php for the private nodes)
 258         if (common_config('site', 'private')) {
 259             return true;
 260         }
 261
 262         // All our remote Oembed images lack a local filename property in the File object
 263         if (!is_null($file->filename)) {
 264             return true;
 265         }
 266
 267         try {
 268             // If we have proper oEmbed data, there should be an entry in the File_oembed
 269             // and File_thumbnail tables respectively. If not, we're not going to do anything.
 270             $file_oembed = File_oembed::getByFile($file);
 271             $thumbnail   = File_thumbnail::byFile($file);
 272         } catch (NoResultException $e) {
 273             // Not Oembed data, or at least nothing we either can or want to use.
 274             return true;
 275         }
 276
 277         try {
 278             $this->storeRemoteFileThumbnail($thumbnail);
 279         } catch (AlreadyFulfilledException $e) {
 280             // aw yiss!
 281         }
 282
 283         $imgPath = $thumbnail->getPath();
 284
 285         return false;
 286     }
 287
 288     /**
 289      * @return boolean          false on no check made, provider name on success
 290      * @throws ServerException  if check is made but fails
 291      */
 292     protected function checkWhitelist($url)
 293     {
 294         if (!$this->check_whitelist) {
 295             return false;   // indicates "no check made"
 296         }
 297
 298         $host = parse_url($url, PHP_URL_HOST);
 299         foreach ($this->domain_whitelist as $regex => $provider) {
 300             if (preg_match("/$regex/", $host)) {
 301                 return $provider;    // we trust this source, return provider name
 302             }
 303         }
 304
 305         throw new ServerException(sprintf(_('Domain not in remote thumbnail source whitelist: %s'), $host));
 306     }
 307
 308     protected function storeRemoteFileThumbnail(File_thumbnail $thumbnail)
 309     {
 310         if (!empty($thumbnail->filename) && file_exists($thumbnail->getPath())) {
 311             throw new AlreadyFulfilledException(sprintf('A thumbnail seems to already exist for remote file with id==%u', $thumbnail->file_id));
 312         }
 313
 314         $url = $thumbnail->getUrl();
 315         $this->checkWhitelist($url);
 316
 317         // First we download the file to memory and test whether it's actually an image file
 318         // FIXME: To support remote video/whatever files, this needs reworking.
 319         common_debug(sprintf('Downloading remote thumbnail for file id==%u with thumbnail URL: %s', $thumbnail->file_id, $url));
 320         $imgData = HTTPClient::quickGet($url);
 321         $info = @getimagesizefromstring($imgData);
 322         if ($info === false) {
 323             throw new UnsupportedMediaException(_('Remote file format was not identified as an image.'), $url);
 324         } elseif (!$info[0] || !$info[1]) {
 325             throw new UnsupportedMediaException(_('Image file had impossible geometry (0 width or height)'));
 326         }
 327
 328         // We'll trust sha256 (File::FILEHASH_ALG) not to have collision issues any time soon :)
 329         $filename = hash(File::FILEHASH_ALG, $imgData) . '.' . common_supported_mime_to_ext($info['mime']);
 330         $fullpath = File_thumbnail::path($filename);
 331         // Write the file to disk. Throw Exception on failure
 332         if (!file_exists($fullpath) && file_put_contents($fullpath, $imgData) === false) {
 333             throw new ServerException(_('Could not write downloaded file to disk.'));
 334         }
 335         // Get rid of the file from memory
 336         unset($imgData);
 337
 338         // Updated our database for the file record
 339         $orig = clone($thumbnail);
 340         $thumbnail->filename = $filename;
 341         $thumbnail->width = $info[0];    // array indexes documented on php.net:
 342         $thumbnail->height = $info[1];   // https://php.net/manual/en/function.getimagesize.php
 343         // Throws exception on failure.
 344         $thumbnail->updateWithKeys($orig);
 345     }
 346
 347     public function onPluginVersion(array &$versions)
 348     {
 349         $versions[] = array('name' => 'Oembed',
 350                             'version' => GNUSOCIAL_VERSION,
 351                             'author' => 'Mikael Nordfeldth',
 352                             'homepage' => 'http://gnu.io/',
 353                             'description' =>
 354                             // TRANS: Plugin description.
 355                             _m('Plugin for using and representing Oembed data.'));
 356         return true;
 357     }
 358 }